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.

Measure Community performance across social channels. Pull total metrics like messages received, response times, and response rates to quantify your team’s customer service impact.

​
Use cases

Tracking Community team performance across platforms manually is time-consuming. Metric reports give you total performance numbers in seconds.

Team performance dashboard

Build a weekly report showing total messages received and response times across all social channels

SLA monitoring

Track average response times and message volumes to ensure your team meets service level agreements

Channel comparison

Compare message volumes across Instagram, TikTok, and Facebook to allocate team resources effectively

​
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.
Test in the UI first: Create a Dashboard in the Dash Social UI and configure your Community report there. This previews the metrics and validates your filters before writing code.
What metrics are included? This report measures your team’s performance in Community across connected social channels. Track metrics like messages received, response times, and engagement.
Supported platforms This report supports these channels:
  • Instagram
  • TikTok
  • Facebook
  • YouTube
  • X
About metric reports Metric reports return aggregated totals for your date range. Use metric reports when you need summed KPIs without time breakdowns.

​
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 gets messages received 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=MESSAGES_RECEIVED
  &report_type=TOTAL_METRIC
Date format matters: Always use YYYY-MM-DD format for dates (e.g., 2025-05-01). Other formats will cause errors.

​
Sample response

The response returns totals for each metric, organized by brand. The value field shows the metric total for your reporting period. The context field shows the comparison period total. The context_change field shows the percentage change. 
{
    "data": {
        "144": {
            "avatar": "https://cdn.dashsocial.com/avatars/2306810931.jpeg",
            "data_type": "BRAND",
            "name": "sunny.today",
            "user_has_access": true
        },
        "metrics": {
            "MESSAGES_RECEIVED": {
                "ALL_CHANNELS": {
                    "context": 3,
                    "context_change": -0.3333333333333333,
                    "value": 2
                }
            }
        }
    },
    "product_category": "COMMUNITY"
}
Understanding the response: Metrics are organized by brand ID and aggregated across all channels. In this example, brand 144 (“sunny.today”) received 2 messages during May 1-7, down from 3 during April 1-7. The context_change value of -0.333 indicates a 33.3% decrease compared to the previous period. Feed this data into your BI tool, dashboard, or analytics pipeline to track Community team performance.

​
Next steps