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.

The Dashboard Reports API lets you export the same analytics data available in the Dash Social UI using a single endpoint: 
GET https://dashboard.dashsocial.com/reports/data
To successfully retrieve data, you must choose:
  1. Data source – Where the data comes from (Owned, Competitive, Earned, etc.)
  2. Output format – How the data is structured (Metric, Graph, or Content)
These two decisions determine:
  • What data is returned
  • Which metrics are available
  • The shape of the JSON response
  • How your integration parses the results
This guide helps you select the correct combination before building your API request.

​
Use case examples

  • Sync monthly engagement totals to a data warehouse
  • Export competitor metrics for benchmarking dashboards
  • Track influencer campaign performance
  • Monitor response time metrics for customer support
  • Build time-series charts in Tableau or Looker

​
How the endpoint works

All Dashboard reports are requested from the same endpoint: 
GET https://dashboard.dashsocial.com/reports/data
Your query parameters define what the API returns. Key parameters include:
  • data_source – Owned, Competitive, Earned, Community, Social Listening, or Total Social Impact
  • report_type – Output structure (TOTAL_METRIC, GRAPH, or CONTENT)
  • metrics – Metrics to retrieve
  • channels – Social platforms (e.g., INSTAGRAM, TIKTOK, FACEBOOK)
  • brand_ids – Brands to report on
  • start_date / end_date – Reporting period
  • context_start_date / context_end_date – Comparison period
Different combinations return different response schemas. Choose carefully—your parsing logic depends on it.

​
Data sources (what you’re measuring)

Each data source pulls from a different dataset.
Data SourceWhat It IncludesCommon Use Cases
OwnedContent published by your brandCampaign reporting, BI exports
CompetitivePublic competitor postsBenchmarking, market analysis
EarnedCreator and UGC brand mentionsInfluencer ROI, earned media tracking
CommunityYour team’s responses to comments and DMsSupport metrics, response time tracking
Social ListeningConversations matching keyword searchesBrand sentiment, hashtag monitoring
Total Social ImpactCombined owned + earned scoreExecutive reporting, unified KPIs
Your selected data source affects:
  • Available metrics
  • Channel support
  • Required filters
  • Data availability

​
Output formats (how the data is structured)

After selecting a data source, choose how the API should return the data. Important: The definition and date basis of each metric does not change across formats. Only the structure of the response changes.

​
Understanding metric types

Metrics fall into different categories, and the category determines how values are calculated and grouped.
  • Account-level metrics represent overall activity across your account during the reporting period. For example, total engagements across all posts.
  • Post-level metrics represent performance tied to specific posts. These are typically grouped by the post’s publish date.
  • UGC metrics represent performance of content that tags or mentions your brand.
Always confirm whether your selected metric is publish-based or activity-based before interpreting totals or trends.

​
Metric format (TOTAL_METRIC)

Returns a single aggregated value for one metric. Use this when you need:
  • KPI snapshots
  • Monthly or quarterly totals
  • Simple executive dashboards
Example response: 
{
    "data": {
        "144": {
            "avatar": "https://cdn.dashsocial.com/avatars/2306810931.jpeg",
            "data_type": "BRAND",
            "metrics": {
                "VIEWS": {
                    "INSTAGRAM": {
                        "context": 270.0,
                        "context_change": 0.5111111111111111,
                        "value": 408.0
                    }
                }
            },
            "name": "sunny.today",
            "user_has_access": true
        }
    },
    "product_category": "OWNED"
}

​
Graph format (GRAPH)

Returns metric grouped by date, with daily or monthly breakdowns. For account-level metrics, values reflect activity that occurred on each date in the reporting period. For post-level metrics, values are grouped by the publish date of posts within the reporting window. Use this when you need:
  • Trend analysis
  • BI dashboards
  • Performance comparisons across time periods
Example response: 
{
    "data": {
        "144": {
            "INSTAGRAM": {
                "VIEWS": {
                    "2025-05-01": 205.0,
                    "2025-05-04": 13.0,
                    "2025-05-05": 11.0,
                    "2025-05-06": 11.0,
                    "2025-05-07": 51.0,
                    "2025-05-08": 117.0
                }
            },
            "avatar": "https://cdn.dashsocial.com/avatars/2306810931.jpeg",
            "data_type": "BRAND",
            "metrics": {
                "VIEWS": {
                    "INSTAGRAM": {
                        "2025-05-01": 205.0,
                        "2025-05-04": 13.0,
                        "2025-05-05": 11.0,
                        "2025-05-06": 11.0,
                        "2025-05-07": 51.0,
                        "2025-05-08": 117.0
                    }
                }
            },
            "name": "sunny.today",
            "user_has_access": true
        }
    },
    "product_category": "OWNED"
}

​
Content format (CONTENT)

Returns individual posts ranked by a selected metric, including metadata. Use this when you need:
  • Top-performing posts
  • Creative analysis
  • Post-level exports
Example response: 
{
    "data": {
        "144": {
            "avatar": "https://cdn.dashsocial.com/avatars/2306810931.jpeg",
            "data_type": "BRAND",
            "name": "sunny.today",
            "user_has_access": true
        },
        "content": [
            {
                "brand_id": 144,
                "brand_media_id": 823836824,
                "caption_question": {
                    "is_question": true,
                    "user_overridden": false
                },
                "caption_sentiment": {
                    "is_negative": false,
                    "is_neutral": true,
                    "is_positive": false,
                    "user_overridden": false
                },
                "collections": {
                    "boards": {
                        "facebook": null,
                        "instagram": null,
                        "instagram_story": null,
                        "linkedin": null,
                        "pinterest": null,
                        "threads": null,
                        "tiktok": null,
                        "twitter": null,
                        "youtube": null
                    },
                    "campaigns": [
                        49324
                    ],
                    "galleries": null
                },
                "comment_sentiment": null,
                "community_engagement": null,
                "content_tags": null,
                "created_at": "2025-05-01T14:16:10",
                "custom_metrics": [
                    {
                        "id": 1991,
                        "value": 0.0
                    }
                ],
                "facebook": null,
                "id": 527602428,
                "instagram": {
                    "ad_account_scoped_insights": null,
                    "ad_ids": null,
                    "adset_ids": null,
                    "amount_spent": null,
                    "avg_time_viewed_sec": 2,
                    "campaign_ids": null,
                    "caption": "May 1st thumbnails",
                    "clicks": null,
                    "comments_count": 0,
                    "cost_per_thruplay": null,
                    "cpc": null,
                    "cpm": null,
                    "ctr": null,
                    "effectiveness": 0.0,
                    "effectiveness_engagements": 0.0,
                    "emv": 300.335,
                    "engagement": 0.0,
                    "engagement_rate_impressions": 0.0,
                    "engagement_rate_public": 0.0,
                    "engagement_rate_views": 0.0,
                    "engagements_public": 0,
                    "entertainment_score": 0.0010660980810234544,
                    "followers_gained": null,
                    "follows": null,
                    "hashtags": [],
                    "impressions": 0,
                    "is_boosted": false,
                    "is_carousel": false,
                    "is_commented": false,
                    "is_mentioned": false,
                    "is_riq": false,
                    "is_tagged": false,
                    "like_count": 0,
                    "paid_and_organic_reach": 3,
                    "paid_and_organic_saved": 0,
                    "paid_and_organic_shares": 0,
                    "paid_comments": 0,
                    "paid_engagement_rate": 0.0,
                    "paid_impressions": 0,
                    "paid_likes": 0,
                    "paid_reach": null,
                    "paid_reactions": null,
                    "paid_saved": 0,
                    "paid_shares": null,
                    "paid_total_engagement": 0,
                    "paid_total_engagements": 0,
                    "paid_video_views": 0,
                    "photo_tags": [],
                    "post_type": "reel",
                    "profile_activity": {
                        "bio_link_clicked": 0,
                        "direction": 0,
                        "email": 0,
                        "other": 0,
                        "text": 0,
                        "total": 0
                    },
                    "profile_visits": null,
                    "public_views": null,
                    "reach": 3,
                    "replays": 0,
                    "saved": 0,
                    "shares": 0,
                    "sum_total_engagement": 0,
                    "sum_total_engagements": 0,
                    "thruplays": null,
                    "timestamp": "2025-05-01T14:15:31+00:00",
                    "total_comments": 0,
                    "total_engagement": 0,
                    "total_impressions": 0,
                    "total_likes": 0,
                    "total_plays": 0,
                    "total_time_viewed_sec": 3,
                    "total_time_viewed_sec_long": 3,
                    "total_video_views": 0,
                    "url": "https://www.instagram.com/reel/DJHPSMbvHe5/",
                    "video_plays_100": null,
                    "video_plays_25": null,
                    "video_plays_50": null,
                    "video_plays_75": null,
                    "video_views": 0,
                    "views": 4
                },
                "instagram_ads": null,
                "instagram_story_frame": null,
                "likeshop": {
                    "clicks": 0,
                    "links": null,
                    "tiktok_clicks": null
                },
                "linkedin": null,
                "media_group": 517557159,
                "meta": {},
                "pinterest": null,
                "predictions": {
                    "engagement": 0.7505790489596662
                },
                "snapchat": null,
                "source": "INSTAGRAM",
                "source_account_id": "2306810931",
                "source_created_at": "2025-05-01T14:15:31",
                "source_id": "18106727113450385",
                "source_type": "OWNED",
                "threads": null,
                "tiktok": null,
                "tiktok_ad": null,
                "twitter": null,
                "type": "VIDEO",
                "variants": [],
                "video": {
                    "duration": 18.0,
                    "frame_rate": 30.0,
                    "sizes": {
                        "original": {
                            "height": 720,
                            "size": 1430441,
                            "url": "https://cdn.dashsocial.com/media/original/1746108968.853499289953.mp4",
                            "width": 720
                        },
                        "original_converted": {
                            "height": 720,
                            "size": 1430441,
                            "url": "https://cdn.dashsocial.com/media/full/1758827691.34561998805.mp4",
                            "width": 720
                        }
                    },
                    "thumbnails": {
                        "medium_square": {
                            "height": 640,
                            "url": "https://images.dashsocial.com/aHR0cHM6Ly9jZG4uZGFzaHNvY2lhbC5jb20vbWVkaWEvZnVsbC8xNzQ2MTA4OTY5LjQ5MTQ1MTU1MzM0NS5qcGVn.jpg?w=640&h=640&fit=cover",
                            "width": 640
                        },
                        "original_converted": {
                            "height": 720,
                            "size": 48322,
                            "url": "https://cdn.dashsocial.com/media/full/1746108969.491451553345.jpeg",
                            "width": 720
                        },
                        "small": {
                            "height": 400,
                            "url": "https://images.dashsocial.com/aHR0cHM6Ly9jZG4uZGFzaHNvY2lhbC5jb20vbWVkaWEvZnVsbC8xNzQ2MTA4OTY5LjQ5MTQ1MTU1MzM0NS5qcGVn.jpg?w=400&h=400",
                            "width": 400
                        },
                        "small_square": {
                            "height": 400,
                            "url": "https://images.dashsocial.com/aHR0cHM6Ly9jZG4uZGFzaHNvY2lhbC5jb20vbWVkaWEvZnVsbC8xNzQ2MTA4OTY5LjQ5MTQ1MTU1MzM0NS5qcGVn.jpg?w=400&h=400&fit=cover",
                            "width": 400
                        }
                    }
                },
                "youtube": null
            }
        ]
    },
    "product_category": "OWNED"
}

​
Choosing the right combination

Use these common patterns:
  • Track your own content performance → Owned + Content
  • Compare against competitors → Competitive + Graph
  • Pull a KPI total → Any data source + Metric
  • Build time-based dashboards → Any data source + Graph
  • Analyze influencer performance → Earned + Graph or Metric

​
Test in the UI first

Before writing code:
  1. Create a Dashboard in the Dash Social UI
  2. Configure your filters and metrics
  3. Confirm the data structure and values
The API parameters mirror the UI configuration. Testing in the UI helps validate your selections before implementing the request.

​
Final outcome

After choosing the correct data source and format, you can:
  • Export structured JSON aligned with your reporting needs
  • Sync data to BI tools or internal dashboards
  • Store consistent schemas in your data warehouse
  • Avoid reworking parsing logic later

​
Next steps

  • Review the full Dashboard Reports API reference
  • See individual guides for Owned, Competitive, or Earned reports
  • Build your first request using a test brand and date range
  • Automate recurring exports for scheduled reporting workflows