Skip to main content
GET
Get workspace analytics

Authorizations

Authorization
string
header
required

Workspace API key from Settings → API Keys.

Query Parameters

range
enum<string>
default:30d

7d (last 7 days), 30d (last 30 days, the default), mtd (month to date) or custom. Days are calendar days in the API key user's time zone, today included.

Available options:
7d,
30d,
mtd,
custom
start
string<date>

First day, Y-m-d. Required with range=custom and ignored for the other presets. Sending start and end without range means custom.

end
string<date>

Last day, Y-m-d, on or after start. Required with range=custom.

channels[]
string<uuid>[]

Only these social accounts. Unknown ids and accounts without analytics are ignored without an error; when none of the ids is usable, the report covers every channel.

Response

The report.

bounds
object

First and last day with analytics data in scope (null when there is none).

range
object

Calendar days in the API key user's time zone (both ends included).

previous_range
object

Calendar days in the API key user's time zone (both ends included).

summary
object

Totals for the range compared with the previous range. posts counts posts published in the range (made in TryPost or not). engagement_rate is a percent. watch_time_minutes and average_watch_time_seconds cover videos.

followers
object
posts
object
top_posts
object

Up to 5 posts of the range with the most reactions, and up to 5 with the most comments.

performance
object[]

One row per channel with at least one post in the range, with each metric compared with the previous range.

coverage
object[]

How far back analytics have been collected for each connected channel. Each channel can have one row per collector.