Skip to navigation

Get aggregate ad campaign stats

View as Markdown

One set of stats totalled across published ad campaigns. Spend and counts are summed; derived metrics (cost per click, CTR, frequency, ROAS) are recalculated from the sums. Reach is a sum of per-campaign reach, so audience overlap across campaigns is counted once per campaign. created_after is inclusive and created_before exclusive.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Headers

X-Partner-IdstringRequired
Your OAuth application client ID.

Query parameters

campaign_idsstringOptional>=1 character

Comma-separated campaign IDs, max 100.

created_afterdatetimeOptional
created_beforedatetimeOptional

Response

campaigns_includedinteger
stats_refreshed_atdatetime or null
statsobject or null

Versioned view over the cached Meta lifetime insights — the raw insights blob is never passed through. All figures are Meta-reported; ads have no Hive-attributed revenue sections (unlike email and SMS).

Errors

422
Unprocessable Entity Error