Skip to main content
GET
Get workspace performance

Authorizations

Authorization
string
header
required

A Replier API key (rpl_...).

Path Parameters

workspace_id
string<uuid>
required

Workspace ID returned by GET /v1/workspaces

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Query Parameters

days
default:30

Reporting window in days, ending now. Ignored when start_date and end_date are given.

start_date
string

First calendar day in timezone, YYYY-MM-DD. Give with end_date.

Pattern: ^\d{4}-\d{2}-\d{2}$
end_date
string

Last calendar day in timezone, YYYY-MM-DD, at most 365 days from start_date. Today counts up to now.

Pattern: ^\d{4}-\d{2}-\d{2}$
channel
enum<string>
Available options:
instagram,
facebook
account_id
string
Minimum string length: 1
timezone
string
default:UTC

IANA time zone for start_date, end_date and the hourly breakdowns.

Required string length: 1 - 64

Response

OK

workspace
object
required
account
object | null
required

The connected account the numbers are limited to; null for the whole workspace.

period
object
required
timezone
string
required
messages_sent
object
required

The dashboard's DMs sent: messages sent in the period, each flow message counted.

interaction_metrics
object
required

The numbers the Replier dashboard shows for this scope, counted from interactions that started in the period.

top_automations
object[]
required

Up to 5 automations with the most interactions in the period, as on the dashboard.

interactions_by_hour
integer[]
required

Interactions started in each hour of the day in timezone, from 00:00.

Required array length: 24 elements
Required range: 0 <= x <= 9007199254740991
click_locations
object
required

Top 5 countries and cities by link clicks in the period, located by Cloudflare from each click. Clicks without a location are left out.