Creator Hub Analytics

Get Creator Hub creator performance table

Returns paginated creator performance rows with engagement and virality metrics for eligible videos.

get/creator-hub/overview/performance

Request

  • Base URL: https://viral.app/api/v1
  • URL: https://viral.app/api/v1/creator-hub/overview/performance
  • 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' | 'totalPosts' | 'totalVideosEligible' | 'totalViews' | 'creatorCpm' | 'totalLikes' | 'totalComments' | 'totalShares' | 'totalBookmarks' | 'engagementRate' | 'viralityRate'
sortDir'asc' | 'desc'
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

currencystring required

Display currency for monetary row values such as creator CPM (single-campaign scope: the campaign currency; otherwise the organization default currency)

eligibilityRefreshedAtstring nullable required
pageCountnumber required

Total number of pages

totalRowsnumber required

Total number of rows

Example response

{
  "data": [
    {
      "campaign": {
        "id": "orgcamp_RwmraAffhMt9",
        "status": "active"
      },
      "topVideo": {
        "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.