Skip to main content
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.

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.
Understanding the response: Metrics are organized by brand ID and channel. Brand 144 (“sunny.today”) had 67 total followers on Instagram during May 1-7 (down from 68 during April 1-7) and received 408 views (up from 270 in April).

Querying multiple brands and channels

When you query multiple brands across multiple channels, add aggregate_by=BRAND and secondary_aggregate_by=CHANNEL to control how the response is grouped. Without these parameters, the grouping depends on the report type and request context, which may not match what you expect.
The response nests channel data under a breakdowns key inside each brand:
Read metrics from each entry using the path data.<brand_id>.breakdowns.<CHANNEL>.metrics.<METRIC>.<CHANNEL>. The top-level metrics object contains totals across all brands and channels.

Metrics

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: