Analytics
Get analytics history
Returns snapshot-based timeseries, platform breakdown, top content, and insights for a date range.
Required permission: `analytics:read`
Accepts `profileId` to target a specific profile. Omit it to use the key’s home profile.
GET
/v1/analytics/historyanalytics:readRequest
Authorization
Send your API key as a Bearer token in the Authorization header.
Query parameters
profileIdstringoptionalProfile to act on. Defaults to the profile the API key was created in.
fromstringoptionalStart date (YYYY-MM-DD). Defaults to 28 days ago.
tostringoptionalEnd date (YYYY-MM-DD). Defaults to today.
Response
Returns 200.
fromstringrequiredtostringrequiredpreviousFromstringrequiredpreviousTostringrequiredsnapshotDaysnumberrequiredhasHistorybooleanrequiredobjectrequired
timeseriesobject[]requiredtimeseriesByPlatformobjectrequiredplatformsobject[]requiredtopContentobject[]requiredinsightsobject[]requiredprofileIdstringoptionalErrors
Failures use the standard error format.
| Status | Code | When it happens |
|---|---|---|
| 400 | invalid_request | The request body or query string failed validation. The message names the offending field. |
| 401 | invalid_api_key | The key does not exist, was revoked, or is malformed. Keys start with cdyn_live_. |
| 403 | profile_not_accessible | The requested profile is outside this key’s scope, or belongs to another account. |
| 429 | rate_limit_exceeded | Too many requests for this key. Honour the Retry-After header before retrying. |
| 500 | internal_error | Something failed on our side. Retry with the same Idempotency-Key; report the requestId if it persists. |