API Glossary
This glossary provides definitions for all metrics and fields that can appear in API responses.
API Contexts
This glossary covers fields from two main API endpoints:
- Posts API (
/posts): Returns individual post data with post-specific metrics
- Analytics API (
/analytics/): Returns aggregated or daily analytics data with account-level metrics
Some fields appear in both endpoints, while others are specific to one context.
Common Fields
| Field |
Description |
id |
Internal record ID for the post |
platform |
Platform type where the post was published. Possible values: facebook, instagram, tiktok, youtube, linkedin, threads, snapchat, dailymotion, pinterest |
created_time |
Date and time when the post was created. Format: ISO 8601 (e.g., 2024-01-15T10:30:00Z) |
description |
Post content or caption text |
title |
Post title. May be null for platforms that don't use titles |
type |
Content or media type of the post. Examples: video_inline, REELS, Tk_VIDEO, article, Story, etc. |
account_id |
ID of the account, page, channel, or profile that published the post or analytics data |
account_name |
Name of the account, page, channel, or profile that published the post or analytics data |
subjects |
Comma-separated list of topics or labels associated with the post. May be null. Requires topics=true parameter |
category |
Category path associated with the post (e.g., Category > Subcategory). May be null. Requires category=true parameter |
brand_id |
Brand identifier associated with the account or post |
brand_ids |
Array of brand identifiers (used in analytics when querying multiple brands) |
date |
Date in YYYY-MM-DD format (used in daily analytics) |
network_id |
Platform-specific network/channel ID (e.g., Facebook page ID, YouTube channel ID) |
storage_avatar |
URL to account avatar image |
permalink |
URL to account profile/page on the platform |
name |
Account name (used in aggregated analytics) |
Common Metrics
| Metric |
Description |
total_interactions |
Total number of interactions (sum of likes, comments, shares, clicks, etc.). Note: For LinkedIn, this field is replaced by engagement_rate |
revenue |
Revenue generated by the post or account. May be null for platforms that don't provide revenue data. Rounded to 2 decimal places. |
reach |
Number of unique users who saw the post (lifetime reach). May be null for platforms that don't provide reach data |
views |
Total number of views for the post, video content, or account |
views_video |
Total video views for the period (used in aggregated analytics) |
duration |
Content duration in seconds. May be null for non-video content or platforms that don't provide duration data |
social_pulse |
Social pulse score (score_distribution). A metric indicating the performance score of the post |
likes |
Number of likes or positive reactions on the post |
comments |
Number of comments on the post. Note: This field may be excluded for some platforms |
shares |
Number of times the post was shared or reposted |
total_time_watched |
Total time watched in seconds. May be null for some platforms |
average_time_watched |
Average time watched in seconds. May be null for some platforms |
followers |
Total followers at end of period (used in analytics) |
new_followers |
New followers gained during the period (used in analytics) |
posts_count |
Number of posts published during the period (used in analytics) |
posts_per_day |
Average number of posts per day (used in aggregated analytics) |
Facebook-Specific Metrics
| Metric |
Description |
video_views |
Number of video views (lifetime) |
total_time_watched |
Total time users watched the video content (in seconds) |
average_time_watched |
Average time users watched the video content (in seconds) |
Instagram-Specific Metrics
| Metric |
Description |
saved |
Number of times the post was saved by users (lifetime) |
average_time_watched |
Average time users watched the video content (in seconds) |
total_time_watched |
Total time users watched the video content (in seconds) |
reach |
Number of unique users who saw the post (lifetime reach). For Instagram, this is the insight_reach_lifetime field renamed to reach |
TikTok-Specific Metrics
| Metric |
Description |
total_time_watched |
Total time users watched the video (in seconds) |
average_time_watched |
Average time users watched the video (in seconds) |
YouTube-Specific Metrics
| Metric |
Description |
comment |
Number of comments on the video |
average_time_watched |
Average duration of video views (in seconds) |
LinkedIn-Specific Metrics
| Metric |
Description |
unique_impressions |
Number of unique impressions (unique users who saw the post) |
clicks |
Number of clicks on the post |
engagement_rate |
Engagement rate as a float value (not rounded). Calculated as: (likes + comments + shares + clicks) / reach (or impressions if reach is 0). This field replaces total_interactions for LinkedIn posts. |
Threads-Specific Metrics
| Metric |
Description |
replies |
Number of replies to the post |
reposts |
Number of reposts of the post |
quotes |
Number of quote posts (posts that quote this post) |
Snapchat-Specific Metrics
| Metric |
Description |
swipes_up |
Number of swipes up on the story |
revenue |
Revenue generated by the story |
view_time |
Total view time for the story (in seconds) |
average_time_watched |
Average time users watched the story per user (in seconds) |
unique_viewers |
Number of unique viewers who saw the story |
screenshots |
Number of screenshots taken of the story |
topsnap_view_time |
Total view time for the top snap (in seconds) |
topsnap_average_time_watched |
Average time users watched the top snap per user (in seconds) |
topsnap_views |
Total number of views for the top snap |
topsnap_unique_views |
Number of unique views for the top snap |
Dailymotion-Specific Metrics
| Metric |
Description |
estimated_revenue |
Estimated revenue generated by the video (float value) |
Pinterest-Specific Metrics
| Metric |
Description |
pin_clicks |
Total number of clicks on the pin |
outbound_clicks |
Total number of outbound clicks (clicks to external links) |
save_rate |
Save rate as a float value (percentage of users who saved the pin) |
comment |
Number of comments on the pin |
pin_click |
Number of clicks on the pin (current metric) |
save |
Number of saves of the pin (current metric) |
video_v50_watch_time |
Video watch time for 50% of viewers (in seconds) |
average_time_watched |
Average time users watched the video (in seconds) |
Analytics API Response Fields
The Analytics API (/analytics/) returns different field structures depending on the query type:
Daily Analytics (type=daily)
| Field |
Description |
date |
Date in YYYY-MM-DD format |
revenue |
Total revenue for the day (rounded to 2 decimals) |
views |
Total views for the day |
followers |
Total followers at end of day |
new_followers |
New followers gained during the day |
posts_count |
Number of posts published on the day |
interactions |
Total interactions for the day |
platform |
Platform code (present when platform parameter is specified) |
brand_id |
Brand identifier (present when multiple brands or when account_id is not used) |
account_id |
Account identifier (present when account_id parameter is used) |
account_name |
Account name (present when account_id parameter is used) |
Aggregated Analytics (type=agg)
| Field |
Description |
platform |
Platform code (present when platform parameter is specified) |
account_id |
Account identifier |
name |
Account name |
network_id |
Platform-specific network/channel ID |
storage_avatar |
URL to account avatar image |
permalink |
URL to account profile/page |
views |
Total views for the period |
views_video |
Total video views for the period |
revenue |
Total revenue for the period (rounded to 2 decimals, may be null) |
interactions |
Total interactions for the period |
posts_per_day |
Average number of posts per day |
new_followers |
Total new followers gained during the period |
followers |
Total followers at end of period |
posts_count |
Total number of posts published |
Both daily and aggregated responses include:
| Field |
Description |
data |
Array of analytics data entries |
total |
Total number of entries returned |
since |
Start date of the query period (YYYY-MM-DD) |
until |
End date of the query period (YYYY-MM-DD) |
platforms |
Platform(s) included in the query ("all" or array of platform codes) |
brand_id |
Brand identifier (present when single brand_id is used) |
brand_ids |
Array of brand identifiers (present when multiple brand_ids are used) |
aggregates |
Aggregated totals and averages (present only in type=agg responses) |
The aggregates object (in aggregated analytics) contains:
| Field |
Description |
aggregates.total |
Object with total sums for numeric fields (views, views_video, revenue, interactions, posts_count) |
aggregates.average |
Object with average values for numeric fields (views, views_video, revenue, interactions, posts_per_day) |