Skip to navigation

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

View as Markdown

Retrieve audience analytics data (followers, demographics, growth) for a specific social media account within a date range.

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_idintegerRequired
Social media account ID
date_fromdateRequired

Start date in format YYYY-MM-DD

date_todateRequired

End date in format YYYY-MM-DD

tzstringOptional

Timezone (e.g. UTC, Europe/Warsaw)

Response

Audience analytics data
statusenumOptional

Analytics availability for the requested account. Values are returned UPPERCASE by the API (the gateway does not normalize them). When not ENABLED or PROCESSING, the rest of the response will typically be empty/null and the agent should surface a reconnect/enable CTA instead of rendering a chart.

account_activebooleanOptional

false when the social account itself is disconnected and needs a fresh OAuth reconnect (independent of status). When false, surface a "Reconnect account" CTA before any analytics data.

dataobjectOptional
Audience data varies by social network and may be empty