Skip to main content
GET
View analytics overview

Authorizations

x-api-key
string
header
required

API key created in Dashboard → Settings → Developer

Query Parameters

scope
enum<string>
default:company

Choose the data scope. company (default) limits results to the API key company's data. agency includes the parent agency and its linked brands. scope=agency requires a parent agency key; other keys receive 403.

Available options:
company,
agency
programId
string

Narrow analytics to a program

creatorId
string

Narrow analytics to a creator

creatorHandle
string

Limit results to creators who have a linked social account with exactly this handle, in any letter case. A leading @ is ignored. A handle that no visible creator linked returns an empty result. Use it when you know the handle but not the creatorId.

platform
enum<string>

Narrow analytics to a platform

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

Response

200 - application/json

Analytics overview returned successfully

data
object