Skip to main content

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.

Pull aggregated KPIs like impressions, followers, and reach across all connected channels. Use this to populate BI dashboards or build high-level performance reports.

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.
See API Quickstart for more details. Supported platforms This report supports these channels:
  • Instagram (including Stories)
  • TikTok
  • Facebook
  • YouTube
  • Pinterest
  • Twitter (X)
  • LinkedIn
About metric reports Metric reports return aggregated totals. You get one summary number per metric (like total followers or total reach). No breakdown by day, week, or individual post. Perfect for headline KPIs on executive dashboards.
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

Deprecation notice: The SINGLE_METRIC report type is being sunset and will be replaced by TOTAL_METRIC. Update your integrations to use TOTAL_METRIC to avoid future breaking changes.
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 brand 144 on Instagram from May 1-7, with April 1-7 as the comparison period.
GET https://dashboard.dashsocial.com/reports/data
  ?channels=INSTAGRAM
  &brand_ids=144
  &start_date=2025-05-01
  &end_date=2025-05-07
  &context_start_date=2025-04-01
  &context_end_date=2025-04-07
  &metrics=VIEWS,TOTAL_FOLLOWERS
  &report_type=TOTAL_METRIC

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 to TOTAL_METRIC
  • start_date / end_date: Reporting period in YYYY-MM-DD format
  • 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).
Date format matters: Always use YYYY-MM-DD format for dates (e.g., 2025-05-01). Other formats will cause errors.
Common errors:
  • 400 error - Check that dates are in YYYY-MM-DD format, metrics are valid for your channels, and brand_id exists
  • Invalid date format - Use YYYY-MM-DD format. 2025-05-01 works, 05/01/2025 doesn’t
  • Missing brand ID - Verify your brand ID is correct. Get it from your account settings

Sample response

The API returns totals for each metric, organized by brand and channel. The value field shows your reporting period total. The context field shows your comparison period total.
{
  "data": {
    "144": {
      "name": "sunny.today",
      "metrics": {
        "TOTAL_FOLLOWERS": {
          "INSTAGRAM": {
            "value": 2800,
            "context": 2700
          }
        },
        "VIEWS": {
          "INSTAGRAM": {
            "value": 1200,
            "context": 900
          }
        }
      }
    }
  }
}
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

Metric NameDescriptionPost TypesMetric API Name
Accounts EngagedThe number of accounts that have interacted with your organic and promoted posts during the reporting periodACCOUNTS_ENGAGED
Accounts ReachedThe 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 - OrganicThe average time your videos were played during a single viewingOrganicAVG_AVG_WATCH_TIME
Avg. Effectiveness - OrganicThe average percentage of users that saw your posts and engaged with them Avg. Effectiveness = Engagements / ReachOrganicAVG_EFFECTIVENESS_ENGAGEMENTS
Avg. Engagement Rate (Followers) - OrganicThe average percentage of your audience that engaged with your posts published during the Reporting Period. Engagement Rate = Organic Engagements / FollowersOrganicAVG_ENGAGEMENT_RATE
Avg. Engagement Rate (Views) - OrganicThe average percentage of your audience that engaged with your posts published during the Reporting Period. Engagement Rate = Organic Engagements / ViewsOrganicAVG_ENGAGEMENT_RATE_VIEWS
Avg. Entertainment Score - OrganicThe 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.OrganicAVG_ENTERTAINMENT_SCORE
Avg. Reach - TotalThe average number of unique accounts that saw your postsOrganic + PromotedAVG_PAID_AND_ORGANIC_REACH
Engagement Rate (Impressions) - PaidThe promoted engagement rate on your posts this periodPromotedAVG_PAID_ENGAGEMENT_RATE
Avg. Reach - PaidThe average number of unique accounts that saw your postsPromotedAVG_PAID_REACH
Avg. Reach - OrganicThe average number of unique accounts that saw your posts published during the Reporting PeriodOrganicAVG_REACH
Avg. Skip Rate - OrganicThe average percentage of viewers who skipped your Reels within the first 3 secondsOrganicAVG_REELS_SKIP_RATE
Book Now Clicks - All PostsThe number of times people tapped the Book Now button on your profile after viewing your postsBOOK_NOW_CLICKS
Call Clicks - All PostsThe number of times people tapped the call button on your profile after viewing your postsCALL_CLICKS
Clicks - PaidThe total number of clicks on your promoted posts. This can include link clicks, clicks to your profile, and more.PromotedCLICKS
Avg. CTR - PaidThe average percentage of times people clicked your promoted posts after seeing themPromotedCLICK_THROUGH_RATE
Comments - Total - All PostsThe number of comments your posts received. Note: Instagram account-level metrics include Instagram Stories stats.Organic + PromotedCOMMENTS_ACCOUNT_STATS
Post Sentiment - NegativeThe percentage of posts published during the reporting period with an overall negative comment sentimentOrganic + PromotedCOMMENT_SENTIMENT_NEGATIVE_RATE
Post Sentiment - NegativeThe percentage of posts with a negative overall comment sentimentOrganicCOMMENT_SENTIMENT_NEGATIVE_RATE_ORGANIC
Post Sentiment - NegativeThe percentage of posts with a negative overall comment sentimentPromotedCOMMENT_SENTIMENT_NEGATIVE_RATE_PROMOTED
Post Sentiment - NeutralThe percentage of posts published during the reporting period with an overall neutral comment sentimentOrganic + PromotedCOMMENT_SENTIMENT_NEUTRAL_RATE
Post Sentiment - NeutralThe percentage of posts with a neutral overall comment sentimentOrganicCOMMENT_SENTIMENT_NEUTRAL_RATE_ORGANIC
Post Sentiment - NeutralThe percentage of posts with a neutral overall comment sentimentPromotedCOMMENT_SENTIMENT_NEUTRAL_RATE_PROMOTED
Post Sentiment - PositiveThe percentage of posts published during the reporting period with an overall positive comment sentimentOrganic + PromotedCOMMENT_SENTIMENT_POSITIVE_RATE
Post Sentiment - PositiveThe percentage of posts with a positive overall comment sentimentOrganicCOMMENT_SENTIMENT_POSITIVE_RATE_ORGANIC
Post Sentiment - PositiveThe percentage of posts with a positive overall comment sentimentPromotedCOMMENT_SENTIMENT_POSITIVE_RATE_PROMOTED
Content Engagements - All PostsThe 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 PostsThe percentage of people who engaged with your content after viewing itCONTENT_ENGAGEMENT_RATE_VIEWS
Avg. CPC - PaidThe average cost per click on your promoted postsPromotedCOST_PER_CLICK
Avg. CPM - PaidThe average cost per 1,000 impressions on your promoted postsPromotedCOST_PER_MILE
Views - Crossposted - OrganicTotal 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.OrganicCROSSPOSTED_VIEWS
Views - Facebook - OrganicThe 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.OrganicFACEBOOK_VIEWS
Followers - LostThe 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 RateThe percentage your followers increased by during the Reporting Period. Follower Growth Rate = (New Followers - Old Followers) / Old Followers x 100%FOLLOWER_GROWTH_RATE
Follows - OrganicThe number of accounts that started following you after viewing your postOrganicFOLLOWS
LikeShop Clicks - All PostsThe total number of clicks on any LikeShop feed products during the reporting periodLIKESHOP_CLICKS
LikeShop ClicksThe number of clicks on your LikeShop feed products on posts published during the reporting periodLIKESHOP_CLICKS_BY_POST
LikeShop Contact Submissions - All PostsThe number of email submissions during the reporting periodLIKESHOP_CONTACT_SUBMISSIONS
LikeShop CTR - All PostsThe percentage of times people clicked your product links after viewing your postLIKESHOP_CTR
LikeShop PostsThe 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 PostsThe number of times your posts were displayed on a person’s screen. This includes repeat views.LIKESHOP_VIEWS
Likes - Total - All PostsThe number of likes your posts received. Note: Instagram account-level metrics include Instagram Stories stats.Organic + PromotedLIKES_ACCOUNT_STATS
Followers - Net NewThe net new number of people who have followed your accountNET_NEW_FOLLOWERS
Number of PostsThe number of posts you’ve published during the reporting periodOrganic + PromotedNUMBER_OF_POSTS
Number of PostsThe number of posts you’ve published during the reporting periodOrganicNUMBER_OF_POSTS_ORGANIC
Number of PostsThe number of posts you’ve published during the reporting periodPromotedNUMBER_OF_POSTS_PAID
Follower Activity - All PostsThe 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 - OrganicThe number of comments on your posts published during the reporting periodOrganicORGANIC_COMMENTS
Likes - OrganicThe number of likes received on posts published during the reporting periodOrganicORGANIC_LIKES
Comments - PaidThe number of comments your posts receivedPromotedPAID_COMMENTS
Cost per ThruPlay - PaidThe average cost per Thruplay for your videosPromotedPAID_COST_PER_THRUPLAY
Impressions - PaidThe number of times your posts were viewed or displayedPromotedPAID_IMPRESSIONS
Likes - PaidThe number of likes your posts receivedPromotedPAID_LIKES
Saves - PaidThe number of times your posts were savedPromotedPAID_SAVES
Shares - PaidThe number of times your promoted posts were sharedPromotedPAID_SHARES_BY_POST
Engagements - PaidThe total number of engagements your promoted posts receivedPromotedPAID_TOTAL_ENGAGEMENTS
Video Views - PaidThe number of times your videos were viewedPromotedPAID_VIDEO_VIEWS
Profile Clicks - OrganicThe number of actions people take when they visit your profile after viewing your post. This can include bio link clicks, calls, emails, and more.OrganicPROFILE_CLICKS
Profile Bio Link ClicksThe number of times people clicked the link in your profile bio after viewing your postOrganicPROFILE_CLICKS_BIO
Profile Call Clicks - OrganicThe number of times people tapped the call button on your profile after viewing your postsOrganicPROFILE_CLICKS_CALL
Profile Directions Clicks - OrganicThe number of times people clicked to get directions from your profile after viewing your postsOrganicPROFILE_CLICKS_DIRECTIONS
Profile Email ClicksThe number of times people tapped the email button on your profile after viewing your postsOrganicPROFILE_CLICKS_EMAIL
Profile Other Clicks - OrganicThe number of times people clicked other profile buttons after viewing your postsOrganicPROFILE_CLICKS_OTHER
Profile Text ClicksThe number of times people tapped the text message button on your profile after viewing your postsOrganicPROFILE_CLICKS_TEXT
Profile ViewsThe amount of times your profile has been viewed during the Reporting PeriodPROFILE_VIEWS
Profile Visits - OrganicThe number of times your profile was visited after viewing your postOrganicPROFILE_VISITS
Reposts - OrganicThe number of times your posts have been repostedOrganicREPOSTS
Reposts - Organic - All PostsThe 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.OrganicREPOSTS_ACCOUNT_STATS
Saves - OrganicThe number of times your posts published during the reporting period were savedOrganicSAVES
Saves - Total - All PostsThe number of times your posts were saved. Note: Instagram account-level metrics include Instagram Stories stats.Organic + PromotedSAVES_ACCOUNT_STATS
Shares - OrganicThe number of times your posts published were shared during the reporting periodOrganicSHARES
Shares - Total - All PostsThe number of times your posts were shared. Note: Instagram account-level metrics include Instagram Stories stats.Organic + PromotedSHARES_ACCOUNT_STATS
Engagements - TotalThe total number of engagements from all posts published during the Reporting PeriodOrganic + PromotedSUM_TOTAL_ENGAGEMENTS
ThruPlays - PaidThe number of times your videos were watched to completion or for at least 15 secondsPromotedTHRUPLAYS
Comments - TotalThe number of comments your posts receivedOrganic + PromotedTOTAL_COMMENTS
Engagements - OrganicThe total number of engagements on your posts published during the reporting period Engagements = (Likes + Saves + Comments + Shares) - (Unlikes + Unsaves + Deleted comments)OrganicTOTAL_ENGAGEMENTS
FollowersThe total number of followers you have on this channelTOTAL_FOLLOWERS
Likes - TotalThe number of likes your posts receivedOrganic + PromotedTOTAL_LIKES
Saves - TotalThe number of times your posts were savedOrganic + PromotedTOTAL_SAVES
Shares - TotalThe number of times your posts were sharedOrganic + PromotedTOTAL_SHARES
Amount Spent - PaidThe 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.PromotedTOTAL_SPENT
Total Social Impact - All PostsTSI 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% - PaidThe number of times your videos were played to 100% of their length, including plays that skipped to this pointPromotedVIDEO_PLAYS_100
Video Plays 25% - PaidThe number of times your videos were played to 25% of their length, including plays that skipped to this pointPromotedVIDEO_PLAYS_25
Video Plays 50% - PaidThe number of times your videos were played to 50% of their length, including plays that skipped to this pointPromotedVIDEO_PLAYS_50
Video Plays 75% - PaidThe number of times your videos were played to 75% of their length, including plays that skipped to this pointPromotedVIDEO_PLAYS_75
Views - OrganicThe number of times your posts were displayed on a person’s screen. This includes repeat views.OrganicVIEWS
Views - All PostsThe 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 PostsThe 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 PostsThe 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 - OrganicThe sum of the time that all viewers watched your videos forOrganicWATCH_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
Related guides: