Pull aggregated KPIs like impressions, followers, and reach across all connected channels. Use this to populate BI dashboards or build high-level performance reports.Documentation Index
Fetch the complete documentation index at: https://developer.dashsocial.com/llms.txt
Use this file to discover all available pages before exploring further.
Use cases
Building executive dashboards manually takes hours. Metric reports pull totals across all channels in seconds.Executive Dashboard
Build weekly performance reports in Looker showing Instagram follower growth and reach across all brands
Quarterly Review
Export Q4 engagement totals for every brand to present performance trends to leadership
Cross-Channel Analysis
Compare your TikTok views against Instagram reach to identify which platform drives more brand awareness
Before you start
Make sure you have:- API access token with permissions to the relevant brand.
- Brand ID for the account you want to query.
- Instagram (including Stories)
- TikTok
- YouTube
- Twitter (X)
Test in the UI first: Create a Dashboard in the Dash Social UI and configure your report there. This previews the metrics and validates your filters before writing code.
Implementation
Step 1: Map your parameters
Review the available parameters before making your API call:Step 2: Make the API call
Send a GET request using the parameters from Step 1. This example pulls views and total followers for brand144 on Instagram from May 1-7, with April 1-7 as the comparison period.
Key query parameters
-
brand_ids: Brand(s) to report on. Separate multiple IDs with commas (e.g.,144,145,146) -
channels: Social platforms to include. Use the API names from Step 1. Request multiple channels in one call by separating them with commas -
metrics: Metrics you want totals for. Common options: views, followers, engagements, reach, impressions. See the full API reference for the complete list with API key names -
report_type: Set toTOTAL_METRIC -
start_date/end_date: Reporting period inYYYY-MM-DDformat -
context_start_date/context_end_date: Comparison period for trend analysis. Use same dates if comparison isn’t needed. Otherwise, choose an earlier period of the same length
Multiple metrics
Request multiple metrics in a single call by separating them with commas (e.g.,VIEWS,TOTAL_FOLLOWERS,TOTAL_ENGAGEMENTS).Sample response
The API returns totals for each metric, organized by brand and channel. Thevalue field shows your reporting period total. The context field shows your comparison period total.
Understanding the response: Metrics are organized by brand ID and channel. Brand
144 (“sunny.today”) had 2,800 total followers during May 1-7 (up from 2,700 during April 1-7) and received 1,200 views (compared to 900 in April).Metrics
- Instagram
- Instagram Stories
- TikTok
- Facebook
- Youtube
- Pinterest
- X
- LinkedIn
| Metric Name | Description | Post Types | Metric API Name |
|---|---|---|---|
| Accounts Engaged | The number of accounts that have interacted with your organic and promoted posts during the reporting period | ACCOUNTS_ENGAGED | |
| Accounts Reached | The number of unique accounts that have seen your content. Estimated by Instagram. This total may not equal the sum of follower and non-follower reach due to differences in how Instagram samples and estimates the metric. Note: Instagram account-level metrics include Instagram Stories stats. | ACCOUNTS_REACHED | |
| Accounts Reached (Followers) | The number of unique follower accounts that have seen your content. Estimated by Instagram. Note: Instagram account-level metrics include Instagram Stories stats. | ACCOUNTS_REACHED_FOLLOWERS | |
| Accounts Reached (Non-Followers) | The number of unique non-follower accounts that have seen your content. Estimated by Instagram. Note: Instagram account-level metrics include Instagram Stories stats. | ACCOUNTS_REACHED_NON_FOLLOWERS | |
| Avg. Time Watched - Organic | The average time your videos were played during a single viewing | Organic | AVG_AVG_WATCH_TIME |
| Avg. Effectiveness - Organic | The average percentage of users that saw your posts and engaged with them Avg. Effectiveness = Engagements / Reach | Organic | AVG_EFFECTIVENESS_ENGAGEMENTS |
| Avg. Engagement Rate (Followers) - Organic | The average percentage of your audience that engaged with your posts published during the Reporting Period. Engagement Rate = Organic Engagements / Followers | Organic | AVG_ENGAGEMENT_RATE |
| Avg. Engagement Rate (Views) - Organic | The average percentage of your audience that engaged with your posts published during the Reporting Period. Engagement Rate = Organic Engagements / Views | Organic | AVG_ENGAGEMENT_RATE_VIEWS |
| Avg. Entertainment Score - Organic | The average Entertainment Score of your Reels published during the reporting period. The score is on a scale of 0 to 10 and is based on volume of organic engagements compared to reach. | Organic | AVG_ENTERTAINMENT_SCORE |
| Avg. Reach - Total | The average number of unique accounts that saw your posts | Organic + Promoted | AVG_PAID_AND_ORGANIC_REACH |
| Engagement Rate (Impressions) - Paid | The promoted engagement rate on your posts this period | Promoted | AVG_PAID_ENGAGEMENT_RATE |
| Avg. Reach - Paid | The average number of unique accounts that saw your posts | Promoted | AVG_PAID_REACH |
| Avg. Reach - Organic | The average number of unique accounts that saw your posts published during the Reporting Period | Organic | AVG_REACH |
| Avg. Skip Rate - Organic | The average percentage of viewers who skipped your Reels within the first 3 seconds | Organic | AVG_REELS_SKIP_RATE |
| Book Now Clicks - All Posts | The number of times people tapped the Book Now button on your profile after viewing your posts | BOOK_NOW_CLICKS | |
| Call Clicks - All Posts | The number of times people tapped the call button on your profile after viewing your posts | CALL_CLICKS | |
| Clicks - Paid | The total number of clicks on your promoted posts. This can include link clicks, clicks to your profile, and more. | Promoted | CLICKS |
| Avg. CTR - Paid | The average percentage of times people clicked your promoted posts after seeing them | Promoted | CLICK_THROUGH_RATE |
| Comments - Total - All Posts | The number of comments your posts received. Note: Instagram account-level metrics include Instagram Stories stats. | Organic + Promoted | COMMENTS_ACCOUNT_STATS |
| Post Sentiment - Negative | The percentage of posts published during the reporting period with an overall negative comment sentiment | Organic + Promoted | COMMENT_SENTIMENT_NEGATIVE_RATE |
| Post Sentiment - Negative | The percentage of posts with a negative overall comment sentiment | Organic | COMMENT_SENTIMENT_NEGATIVE_RATE_ORGANIC |
| Post Sentiment - Negative | The percentage of posts with a negative overall comment sentiment | Promoted | COMMENT_SENTIMENT_NEGATIVE_RATE_PROMOTED |
| Post Sentiment - Neutral | The percentage of posts published during the reporting period with an overall neutral comment sentiment | Organic + Promoted | COMMENT_SENTIMENT_NEUTRAL_RATE |
| Post Sentiment - Neutral | The percentage of posts with a neutral overall comment sentiment | Organic | COMMENT_SENTIMENT_NEUTRAL_RATE_ORGANIC |
| Post Sentiment - Neutral | The percentage of posts with a neutral overall comment sentiment | Promoted | COMMENT_SENTIMENT_NEUTRAL_RATE_PROMOTED |
| Post Sentiment - Positive | The percentage of posts published during the reporting period with an overall positive comment sentiment | Organic + Promoted | COMMENT_SENTIMENT_POSITIVE_RATE |
| Post Sentiment - Positive | The percentage of posts with a positive overall comment sentiment | Organic | COMMENT_SENTIMENT_POSITIVE_RATE_ORGANIC |
| Post Sentiment - Positive | The percentage of posts with a positive overall comment sentiment | Promoted | COMMENT_SENTIMENT_POSITIVE_RATE_PROMOTED |
| Content Engagements - All Posts | The number of likes, comments, shares, and saves your content received during the reporting period. Note: Instagram account-level metrics include Instagram Stories stats. | CONTENT_ENGAGEMENTS | |
| Engagement Rate (Views) - All Posts | The percentage of people who engaged with your content after viewing it | CONTENT_ENGAGEMENT_RATE_VIEWS | |
| Avg. CPC - Paid | The average cost per click on your promoted posts | Promoted | COST_PER_CLICK |
| Avg. CPM - Paid | The average cost per 1,000 impressions on your promoted posts | Promoted | COST_PER_MILE |
| Views - Crossposted - Organic | Total views across Instagram and Facebook for content crossposted natively between platforms. For Reels, includes views from crossposting or cross-app recommendations, where Reels appear on Facebook under your Instagram username. | Organic | CROSSPOSTED_VIEWS |
| Views - Facebook - Organic | The number of views your posts received on Facebook, for content crossposted natively from Instagram. For Reels, also includes views from cross-app recommendations, where Reels appear on Facebook under your Instagram username. | Organic | FACEBOOK_VIEWS |
| Followers - Lost | The total numbers of users who unfollowed your account during the Reporting Period. *Lost Followers data is received once per day in the Pacific Timezone. | FOLLOWERS_LOST | |
| Followers - Growth Rate | The percentage your followers increased by during the Reporting Period. Follower Growth Rate = (New Followers - Old Followers) / Old Followers x 100% | FOLLOWER_GROWTH_RATE | |
| Follows - Organic | The number of accounts that started following you after viewing your post | Organic | FOLLOWS |
| LikeShop Clicks - All Posts | The total number of clicks on any LikeShop feed products during the reporting period | LIKESHOP_CLICKS | |
| LikeShop Clicks | The number of clicks on your LikeShop feed products on posts published during the reporting period | LIKESHOP_CLICKS_BY_POST | |
| LikeShop Contact Submissions - All Posts | The number of email submissions during the reporting period | LIKESHOP_CONTACT_SUBMISSIONS | |
| LikeShop CTR - All Posts | The percentage of times people clicked your product links after viewing your post | LIKESHOP_CTR | |
| LikeShop Posts | The number of posts you’ve published during the reporting period that include product links. These are the posts visible on your LikeShop. | LIKESHOP_POSTS | |
| LikeShop Views - All Posts | The number of times your posts were displayed on a person’s screen. This includes repeat views. | LIKESHOP_VIEWS | |
| Likes - Total - All Posts | The number of likes your posts received. Note: Instagram account-level metrics include Instagram Stories stats. | Organic + Promoted | LIKES_ACCOUNT_STATS |
| Followers - Net New | The net new number of people who have followed your account | NET_NEW_FOLLOWERS | |
| Number of Posts | The number of posts you’ve published during the reporting period | Organic + Promoted | NUMBER_OF_POSTS |
| Number of Posts | The number of posts you’ve published during the reporting period | Organic | NUMBER_OF_POSTS_ORGANIC |
| Number of Posts | The number of posts you’ve published during the reporting period | Promoted | NUMBER_OF_POSTS_PAID |
| Follower Activity - All Posts | The average times your followers were active during the reporting period. Data from the Instagram API may be delayed by up to 3 days. | ONLINE_FOLLOWERS | |
| Comments - Organic | The number of comments on your posts published during the reporting period | Organic | ORGANIC_COMMENTS |
| Likes - Organic | The number of likes received on posts published during the reporting period | Organic | ORGANIC_LIKES |
| Comments - Paid | The number of comments your posts received | Promoted | PAID_COMMENTS |
| Cost per ThruPlay - Paid | The average cost per Thruplay for your videos | Promoted | PAID_COST_PER_THRUPLAY |
| Impressions - Paid | The number of times your posts were viewed or displayed | Promoted | PAID_IMPRESSIONS |
| Likes - Paid | The number of likes your posts received | Promoted | PAID_LIKES |
| Saves - Paid | The number of times your posts were saved | Promoted | PAID_SAVES |
| Shares - Paid | The number of times your promoted posts were shared | Promoted | PAID_SHARES_BY_POST |
| Engagements - Paid | The total number of engagements your promoted posts received | Promoted | PAID_TOTAL_ENGAGEMENTS |
| Video Views - Paid | The number of times your videos were viewed | Promoted | PAID_VIDEO_VIEWS |
| Profile Clicks - Organic | The number of actions people take when they visit your profile after viewing your post. This can include bio link clicks, calls, emails, and more. | Organic | PROFILE_CLICKS |
| Profile Bio Link Clicks | The number of times people clicked the link in your profile bio after viewing your post | Organic | PROFILE_CLICKS_BIO |
| Profile Call Clicks - Organic | The number of times people tapped the call button on your profile after viewing your posts | Organic | PROFILE_CLICKS_CALL |
| Profile Directions Clicks - Organic | The number of times people clicked to get directions from your profile after viewing your posts | Organic | PROFILE_CLICKS_DIRECTIONS |
| Profile Email Clicks | The number of times people tapped the email button on your profile after viewing your posts | Organic | PROFILE_CLICKS_EMAIL |
| Profile Other Clicks - Organic | The number of times people clicked other profile buttons after viewing your posts | Organic | PROFILE_CLICKS_OTHER |
| Profile Text Clicks | The number of times people tapped the text message button on your profile after viewing your posts | Organic | PROFILE_CLICKS_TEXT |
| Profile Views | The amount of times your profile has been viewed during the Reporting Period | PROFILE_VIEWS | |
| Profile Visits - Organic | The number of times your profile was visited after viewing your post | Organic | PROFILE_VISITS |
| Reposts - Organic | The number of times your posts have been reposted | Organic | REPOSTS |
| Reposts - Organic - All Posts | The number of times your posts have been reposted, minus any un-reposts. This metric can be negative if un-reposts exceed reposts. Note: Instagram account-level metrics include Instagram Stories stats. | Organic | REPOSTS_ACCOUNT_STATS |
| Saves - Organic | The number of times your posts published during the reporting period were saved | Organic | SAVES |
| Saves - Total - All Posts | The number of times your posts were saved. Note: Instagram account-level metrics include Instagram Stories stats. | Organic + Promoted | SAVES_ACCOUNT_STATS |
| Shares - Organic | The number of times your posts published were shared during the reporting period | Organic | SHARES |
| Shares - Total - All Posts | The number of times your posts were shared. Note: Instagram account-level metrics include Instagram Stories stats. | Organic + Promoted | SHARES_ACCOUNT_STATS |
| Engagements - Total | The total number of engagements from all posts published during the Reporting Period | Organic + Promoted | SUM_TOTAL_ENGAGEMENTS |
| ThruPlays - Paid | The number of times your videos were watched to completion or for at least 15 seconds | Promoted | THRUPLAYS |
| Comments - Total | The number of comments your posts received | Organic + Promoted | TOTAL_COMMENTS |
| Engagements - Organic | The total number of engagements on your posts published during the reporting period Engagements = (Likes + Saves + Comments + Shares) - (Unlikes + Unsaves + Deleted comments) | Organic | TOTAL_ENGAGEMENTS |
| Followers | The total number of followers you have on this channel | TOTAL_FOLLOWERS | |
| Likes - Total | The number of likes your posts received | Organic + Promoted | TOTAL_LIKES |
| Saves - Total | The number of times your posts were saved | Organic + Promoted | TOTAL_SAVES |
| Shares - Total | The number of times your posts were shared | Organic + Promoted | TOTAL_SHARES |
| Amount Spent - Paid | The total amount of money you’ve spent boosting your posts. Due to API delays, recent spend figures may be estimated for up to 48 hours. | Promoted | TOTAL_SPENT |
| Total Social Impact - All Posts | TSI is like a market index for your brand’s social presence - it brings together everything your brand does across social to reveal the strength of your total presence. It rolls up all your channels, content, and engagement into one score that grows over time, giving you a clear view of performance and momentum. | TOTAL_TSI | |
| Video Plays 100% - Paid | The number of times your videos were played to 100% of their length, including plays that skipped to this point | Promoted | VIDEO_PLAYS_100 |
| Video Plays 25% - Paid | The number of times your videos were played to 25% of their length, including plays that skipped to this point | Promoted | VIDEO_PLAYS_25 |
| Video Plays 50% - Paid | The number of times your videos were played to 50% of their length, including plays that skipped to this point | Promoted | VIDEO_PLAYS_50 |
| Video Plays 75% - Paid | The number of times your videos were played to 75% of their length, including plays that skipped to this point | Promoted | VIDEO_PLAYS_75 |
| Views - Organic | The number of times your posts were displayed on a person’s screen. This includes repeat views. | Organic | VIEWS |
| Views - All Posts | The number of times your posts were viewed or displayed. The sum of follower and non-follower views may not add to the Total due to differences in how Instagram samples and estimates the metric. Note: Instagram account-level metrics include Instagram Stories stats. | VIEWS_ALL_ACCOUNT_STATS | |
| Views (Followers) - All Posts | The number of times your posts were viewed by your followers during the reporting period. The sum of follower and non-follower views may not add to the Total due to differences in how Instagram samples and estimates the metric. Note: Instagram account-level metrics include Instagram Stories stats. | VIEWS_FOLLOWERS_ACCOUNT_STATS | |
| Views (Non-Followers) - All Posts | The number of times your posts were viewed by non-followers during the reporting period. The sum of follower and non-follower views may not add to the Total due to differences in how Instagram samples and estimates the metric. Note: Instagram account-level metrics include Instagram Stories stats. | VIEWS_NON_FOLLOWERS_ACCOUNT_STATS | |
| Total Time Watched - Organic | The sum of the time that all viewers watched your videos for | Organic | WATCH_TIME |
Next steps
You now have a JSON response with total performance metrics per brand and platform. Use this data to:- Power BI dashboards - Feed weekly or quarterly totals into Looker, Tableau, or other BI tools
- Compare performance - Analyze growth between brands or channels
- Executive reporting - Summarize KPIs for leadership