Skip to main content
GET
Get comprehensive KPIs

Authorizations

x-api-key
string
header
required

API key for authentication. Get yours from Settings → Integrations

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

Response

200 - application/json

Successfully retrieved KPIs

data
object