Skip to navigation

Social · Analytics · Get aggregated analytics for a social media account

View as Markdown

Retrieve aggregated analytics metrics (totals and averages) for one or more social media accounts within a date range. At least one of account_id or account_ids must be provided.

Authentication

AuthorizationApi-Key

Header authentication of the form Api-Key <token>

OR
AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

account_idintegerOptional

Social media account ID. Takes priority over account_ids if both provided.

account_idsstringOptional

Comma-separated list of social media account IDs (e.g. "123,456,789"). Used when account_id is not provided.

date_fromdateRequired

Start date in format YYYY-MM-DD

date_todateRequired

End date in format YYYY-MM-DD

Response

Aggregated analytics metrics
accounts_statuslist of objects or nullOptional

Per-account analytics availability for each requested account_ids entry. Use this to surface reconnect/enable CTAs for problematic accounts before consuming data (which is rolled up across the enabled accounts only).

datalist of objects or nullOptional
baseLineobjectOptional