API reference

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:read

Request

Authorization

Send your API key as a Bearer token in the Authorization header.

Query parameters

profileIdstringoptional

Profile to act on. Defaults to the profile the API key was created in.

fromstringoptional

Start date (YYYY-MM-DD). Defaults to 28 days ago.

tostringoptional

End date (YYYY-MM-DD). Defaults to today.

Response

Returns 200.

fromstringrequired
tostringrequired
previousFromstringrequired
previousTostringrequired
snapshotDaysnumberrequired
hasHistorybooleanrequired
objectrequired
timeseriesobject[]required
timeseriesByPlatformobjectrequired
platformsobject[]required
topContentobject[]required
insightsobject[]required
profileIdstringoptional

Errors

Failures use the standard error format.

StatusCodeWhen it happens
400invalid_requestThe request body or query string failed validation. The message names the offending field.
401invalid_api_keyThe key does not exist, was revoked, or is malformed. Keys start with cdyn_live_.
403profile_not_accessibleThe requested profile is outside this key’s scope, or belongs to another account.
429rate_limit_exceededToo many requests for this key. Honour the Retry-After header before retrying.
500internal_errorSomething failed on our side. Retry with the same Idempotency-Key; report the requestId if it persists.