Skip to navigation
Social MediaAnalytics

Social · Analytics · Get time-series analytics for specific metrics

View as Markdown

Retrieve time-series data for selected metrics of a social media account within a date range. Available metrics depend on the social network:

  • Instagram: impressions (deprecated), views, reach, profile_views, follower_count, text_message_clicks, website_clicks, email_contacts, posts_count, accounts_engaged, profile_links_taps, replies, shares, saves, total_interactions
  • Facebook: engaged_users, post_impression, post_impression_total, post_reach_total, post_impression_paid, post_reach_paid, post_reach, page_post_engagements, new_fan, reactions, total_fans, total_follows, link_clicks, video_play, other_clicks, photo_view, posts_count, post_reach_viral, page_reach
  • LinkedIn (Company): posts_count, impressions, unique_impressions, comments, likes, clicks, engagement, shares, allFollowers, organicFollowers, paidFollowers
  • LinkedIn (Personal): memberFollowers, impressions, comments, reactions, shares
  • Twitter/X: posts_count, retweetCount, replyCount, likeCount, quoteCount
  • YouTube: views, comments, likes, dislikes, estimatedMinutesWatched, averageViewDuration, posts_count
  • Pinterest: engagement_rate, save, pin_click_rate, outbound_click, video_mrc_view, video_avg_watch_time, impression, engagement, video_v50_watch_time, outbound_click_rate, save_rate, quartile_95_percent_view, video_start, video_10s_view, pin_click, posts_count
  • TikTok (Personal): posts_count, follower_count, likes_count
  • TikTok Business: posts_count, audience_genders, audience_countries, comments, shares, audience_activity, profile_views, followers_count, video_views
  • Threads: views, followers_count, likes, replies, reposts, quotes, clicks, posts_count
  • Google My Business: posts_count, queries_indirect, queries_direct, queries_chain, views_maps, views_search, actions_website, actions_phone, actions_driving_directions, business_impressions_desktop_maps, business_impressions_mobile_maps, business_impressions_mobile_search, business_impressions_desktop_search

Unknown metrics are ignored by the API.

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.

Request

This endpoint expects an object.
account_idintegerRequired
Social media account ID
metricslist of enumsRequired

List of metrics to retrieve. Available values depend on the social network — see endpoint description.

date_fromdateRequired

Start date in format YYYY-MM-DD

date_todateRequired

End date in format YYYY-MM-DD

tzstringOptionalDefaults to UTC

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

Response

Time-series data for requested metrics

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.

datalist of objects or nullOptional
baseLinemap from strings to objects or nullOptional
Aggregated totals for the requested period, keyed by metric id
additionalmap from strings to lists of objects or nullOptional

Extra metrics computed over different time windows (e.g. 28-day reach), keyed by metric id