Creator Hub Analytics

Get Creator Hub overview events feed

Returns timeline events across campaign lifecycle, creator assignments, posted videos, cycles, and payouts. Pages by digest: posted videos fold into one digest per day, campaign, and creator, and billing-cycle starts and ends into one per day, so perPage, pageCount, and totalRows count digests and a page carries every event of its digests.

get/creator-hub/overview/events

Request

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

Query parameters

pagenumber

Page number (1-based index)

Example:1
perPagenumber

Digests per page (see the response's totalRows): a page carries every event of its digests, so it can hold more events than this.

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'
eventCategory'all' | 'campaign' | 'videos'

Response

OK

pageCountnumber required

Total number of pages of digests

totalRowsnumber required

Total number of digests (feed rows), not raw events

Example response

{
  "data": [
    {
      "campaign": {
        "id": "orgcamp_RwmraAffhMt9",
        "status": "active"
      }
    }
  ],
  "resolvedRange": {
    "from": "2025-01-01",
    "to": "2025-01-31"
  }
}

Changes

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