Campaign reach summary
Total videos and views for a campaign (a set of payout cycles you choose), with a per-cycle breakdown. tagIds and groupIds scope every figure (to sets carrying a tag, and to creators in a group). Videos count once, from the latest snapshot inside their cycle. Spend and budget are on GET /brands/{brandId}/campaign/spend.
bearerAuth analytics:readAuthorizationBearer <token>Personal access token. Scopes: account:read, creator:read, creator:earnings, managed:read, coach:read, brand:read, creators:read, videos:read, analytics:read, recruitment:read, engagement:read, support:read, integrations:read, payouts:read, funds:read, billing:read.
Scope: analytics:read
brandId*stringA brand id from GET /me or GET /creator/brands.
1 <= lengthcycleIds*stringComma-separated payout cycle ids (from GET /brands/{brandId}/cycles): the cycles that make up the campaign.
1 <= lengthtagIds?stringComma-separated tag ids (from GET /brands/{brandId}/tags). Matches any of them.
groupIds?stringComma-separated creator-group ids (from GET /brands/{brandId}/creator-groups); __ungrouped__ selects creators in no group. Matches creators in any of them. An unknown group id is a 400.
Success.
application/json- response
metrics*cycles*array<>curl -X GET 'https://example.com/api/v1/brands/string/campaign/summary?cycleIds=string'{ "metrics": { "totalVideos": 0, "totalViews": 0 }, "cycles": [ { "cycleId": "string", "startDate": "string", "endDate": "string", "status": "string", "videos": 0, "views": 0 } ]}Campaign spend and budget GET
What a campaign (a set of payout cycles) has cost: spend is base pay + CPM bonus, the pay your creators earn on those cycles' sets. With `prepayment` (the budget you were prepaid), also what remains and whether spend has reached `thresholdPct` of it. `tagIds` and `groupIds` scope the totals. `breakdown=tag` adds spend and CPM per tag (attributed by the set's tags; a set with several tags counts under each; `tagIds` doesn't apply to it). `breakdown=day` adds spend per day, which is null on every day when `tagIds` or `groupIds` is set (pay can't be attributed to a day that way) and on days no cycle covers; a day can be negative when pay was revised down. Full admins only.
Campaign reach by tag GET
Videos and views per tag across the campaign's cycles. Every brand tag is listed, with zeros where it had no activity. A video with several tags counts under each, so tag totals can exceed the campaign total. `groupIds` narrows whose activity is counted. Spend per tag is on GET /brands/{brandId}/campaign/spend?breakdown=tag.