Brand key required
Analytics
The single-call dashboard: aggregate revenue, commission, click, and conversion totals plus your top-earning creators. Ideal for a daily report or a health check.
Get the overview
GET/v1/analytics
| Parameter | Type | Description |
|---|---|---|
| start | string | ISO 8601 start of the reporting period. Default: 30 days ago. |
| end | string | ISO 8601 end of the reporting period. Default: now. |
request
curl "https://api.ugcroster.com/v1/analytics?start=2026-06-01T00:00:00Z&end=2026-06-13T23:59:59Z" \
-H "Authorization: Bearer rsk_brand_key"response 200
{
"data": {
"period": {
"start": "2026-06-01T00:00:00Z",
"end": "2026-06-13T23:59:59Z"
},
"summary": {
"total_revenue": 24650.00,
"total_commissions": 3697.50,
"total_clicks": 18470,
"total_conversions": 930,
"active_campaigns": 5,
"active_creators": 42
},
"top_creators": [
{
"email": "emma@example.com",
"name": "Emma Chen",
"commission": 697.50,
"revenue": 4650.00,
"conversions": 93
}
]
}
}What the numbers mean
| Field | Type | Description |
|---|---|---|
| total_revenue | number | Attributed order revenue across all affiliate links. |
| total_commissions | number | Commission earned by creators on that revenue. |
| total_clicks / total_conversions | number | Traffic and orders across all links. |
| active_campaigns | integer | Campaigns currently live (excludes drafts, pending review, and archived). |
| active_creators | integer | Distinct creators with an affiliate link or a roster hire. |
| top_creators | array | Up to 10 creators ranked by commission earned. |
Revenue and click totals are lifetime link aggregates reported within the requested period window. For per-day series, pull /v1/affiliates/performance with date_from/date_to, and for content-side metrics use the content report.