Skip to main content
GET
General analytics overview

Authorizations

x-api-key
string
header
required

API key for authentication. Get yours from Settings → Integrations. A key created by a team member acts as that member and follows their current team permissions; a request outside those permissions returns 403 { "error": "insufficient_scope", "scope": "<required>" }.

Query Parameters

scope
enum<string>
default:company

Data scope. company (default) returns only the authenticated company's own data. agency returns the union of the parent agency plus every subaccount — use this to pull analytics across all brands.

scope=agency requires an API key belonging to a parent agency account (an account with isAgency=true and no parent). Passing it with a non-agency or subaccount key returns 403.

Available options:
company,
agency
programId
string

Filter analytics by specific program

creatorId
string

Filter analytics by specific creator

platform
enum<string>

Filter analytics by platform. Use twitter rather than x, which is only the display name - this filter matches the stored value literally and does not resolve aliases. An unrecognised platform is not rejected; it simply matches nothing.

Available options:
tiktok,
instagram,
youtube,
snapchat,
facebook,
twitter,
linkedin
fromDate
string<date>
toDate
string<date>

Response

200 - application/json

Successfully retrieved analytics overview

data
object