Creator Hub Analytics

Get Creator Hub creator activity table

Returns paginated creator activity rows with current billing-period progress and pace status, posted-video progress against rounded prorated campaign targets for the requested range, and recent 14-day post activity. Supports pace-based filtering (all, onSchedule, behindSchedule — the latter grouping runningTight and overdue) and defaults to sorting by progress ratio descending.

get/creator-hub/overview/activity

Request

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

Query parameters

pagenumber

Page number (1-based index)

Example:1
perPagenumber

Number of items per page (1-100)

Example:10
sortCol'creatorName' | 'campaignName' | 'postedVideos' | 'eligibleVideos' | 'targetVideos' | 'progressRatio'
sortDir'asc' | 'desc'
progressFilter'all' | 'onSchedule' | 'behindSchedule'
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

eligibilityRefreshedAtstring nullable required
pageCountnumber required

Total number of pages

totalRowsnumber required

Total number of rows

Example response

{
  "data": [
    {
      "campaign": {
        "id": "orgcamp_RwmraAffhMt9",
        "videoTargetUnit": "videos",
        "status": "active"
      },
      "currentPeriod": {
        "platforms": [
          {
            "platform": "facebook"
          }
        ]
      },
      "lastVideo": {
        "platform": "facebook",
        "platformVideoId": "7123456789012345678"
      }
    }
  ],
  "resolvedRange": {
    "from": "2025-01-01",
    "to": "2025-01-31"
  }
}

Changes

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