Skip to main content
GET
/
brands
/
{brand_id}
/
campaigns
/
{campaign_id}
/
stats
/
overview
cURL
curl --request GET \
  --url https://library-backend.dashsocial.com/brands/{brand_id}/campaigns/{campaign_id}/stats/overview \
  --header 'Authorization: Bearer <token>'
{
  "data": {
    "CUSTOM_METRICS": {},
    "FACEBOOK": {
      "avg_effectiveness_rate": 123,
      "avg_effectiveness_rate_v2": 123,
      "avg_engagement_rate": 123,
      "avg_engagement_rate_v2": 123,
      "avg_reach": 123,
      "avg_reach_v2": 123,
      "engagements": 123,
      "engagements_v2": 123,
      "impressions": 123,
      "link_clicks": 123,
      "number_of_media": 123,
      "number_of_videos": 123,
      "video_views": 123,
      "views": 123,
      "views_only_videos": 123
    },
    "INSTAGRAM": {
      "avg_avg_watch_time_sec": 123,
      "avg_effectiveness_engagements_rate": 123,
      "avg_effectiveness_rate": 123,
      "avg_engagement_rate": 123,
      "avg_engagement_rate_views": 123,
      "avg_reach": 123,
      "engagements": 123,
      "impressions": 123,
      "number_of_media": 123,
      "number_of_videos": 123,
      "paid_engagements": 123,
      "paid_impressions": 123,
      "paid_video_views": 123,
      "total_engagements": 123,
      "total_impressions": 123,
      "total_video_views": 123,
      "video_views": 123,
      "views": 123,
      "views_only_videos": 123
    },
    "INSTAGRAM_CREATORS": {
      "avg_engagement_rate": 123,
      "engagements": 123,
      "impressions": 123,
      "number_of_media": 123,
      "views": 123
    },
    "INSTAGRAM_STORY": {
      "avg_completion_rate": 123,
      "avg_completion_rate_views": 123,
      "avg_exit_rate": 123,
      "avg_exit_rate_views": 123,
      "avg_reach": 123,
      "exits": 123,
      "impressions": 123,
      "link_clicks": 123,
      "number_of_media": 123,
      "views": 123
    },
    "LIKESHOP": {
      "link_clicks": 123
    },
    "PINTEREST": {
      "avg_engagement_rate": 123,
      "engagements": 123,
      "impressions": 123,
      "link_clicks": 123,
      "number_of_media": 123,
      "number_of_videos": 123,
      "saves": 123,
      "video_views": 123
    },
    "RELATIONSHIPS": {
      "avg_engagement_rate": 123,
      "comments": 123,
      "engagements": 123,
      "likes": 123,
      "number_of_media": 123,
      "video_views": 123
    },
    "TIKTOK": {
      "avg_engagement_rate": 123,
      "avg_engagement_rate_views": 123,
      "avg_reach": 123,
      "avg_retention_rate": 123,
      "engagements": 123,
      "fyp_views_percentage": 123,
      "number_of_media": 123,
      "video_views": 123
    },
    "TIKTOK_CREATORS": {
      "avg_engagement_rate": 123,
      "engagements": 123,
      "number_of_media": 123,
      "video_views": 123
    },
    "TIKTOK_LIKESHOP": {
      "link_clicks": 123
    },
    "TWITTER": {
      "avg_engagement_rate": 123,
      "avg_engagement_rate_organic": 123,
      "avg_engagement_rate_promoted": 123,
      "engagements": 123,
      "engagements_organic": 123,
      "engagements_promoted": 123,
      "impressions": 123,
      "impressions_organic": 123,
      "impressions_promoted": 123,
      "likes": 123,
      "likes_organic": 123,
      "likes_promoted": 123,
      "link_clicks": 123,
      "link_clicks_organic": 123,
      "link_clicks_promoted": 123,
      "number_of_media": 123,
      "number_of_videos": 123,
      "video_views": 123,
      "video_views_organic": 123,
      "video_views_promoted": 123
    },
    "UGC": {
      "avg_engagement_rate": 123,
      "engagements": 123,
      "estimated_reach": 123,
      "mentions": 123,
      "number_of_media": 123,
      "people_tags": 123
    },
    "YOUTUBE": {
      "avg_view_duration": 123,
      "dislikes": 123,
      "engagements": 123,
      "likes": 123,
      "number_of_media": 123,
      "video_views": 123,
      "watch_time": 123
    },
    "overview": {
      "avg_emv": 123,
      "avg_engagement_rate": 123,
      "avg_engagements": 123,
      "emv": 123,
      "engagements": 123,
      "impressions": 123,
      "impressions_v2": 123,
      "link_clicks": 123,
      "number_of_media": 123,
      "total_creator_likes": 123,
      "video_views": 123,
      "video_views_v2": 123
    },
    "owned_summary": {
      "avg_engagement_rate": 123,
      "avg_engagements": 123,
      "engagements": 123,
      "impressions_v2": 123,
      "link_clicks": 123,
      "number_of_media": 123,
      "video_views_v2": 123
    }
  }
}

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.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

brand_id
integer<int32>
required

The Dash Social assigned ID of the brand.

campaign_id
integer
required

The ID of the campaign object.

Required range: x >= 0

Query Parameters

start_date
string | null

A formatted datetime string in UTC.

Pattern: ^\d{4}-\d{2}-\d{2}(T\d{2}:\d{2}:\d{2}(Z|((\+|-)\d{2}:\d{2})))?$
Example:

"2019-12-01"

end_date
string | null

A formatted datetime string in UTC.

Pattern: ^\d{4}-\d{2}-\d{2}(T\d{2}:\d{2}:\d{2}(Z|((\+|-)\d{2}:\d{2})))?$
Example:

"2019-12-12"

Response

OK

data
object