Creator Hub Analytics

Get Creator Hub overview KPIs

Returns Creator Hub overview metrics for assigned creators: campaign views (views gained by videos posted while the creator was assigned, no video-age window), posted and eligible videos, spend, and effective/paid CPM.

get/creator-hub/overview/kpis

Request

  • Base URL: https://viral.app/api/v1
  • URL: https://viral.app/api/v1/creator-hub/overview/kpis
  • Auth: API key in header x-api-key

Query parameters

scope'dateRange' | 'allTime'
fromstring required

Start date in ISO format (YYYY-MM-DD)

tostring required

End date in ISO format (YYYY-MM-DD)

{
  "from": "2025-01-01",
  "to": "2025-01-31"
}
campaignIdsstring[]
[
  "orgcamp_RwmraAffhMt9"
]
creatorIdsstring[]
publicationMode'allEligible' | 'onlyPublished'

Response

OK

OR

Changes

No recorded changes to this operation across all 1 revision of this API.