cURL
curl --request GET \
--url https://library-backend.dashsocial.com/brands/{brand_id}/campaigns/{campaign_id}/stats/overview \
--header 'Authorization: Bearer <token>'import requests
url = "https://library-backend.dashsocial.com/brands/{brand_id}/campaigns/{campaign_id}/stats/overview"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://library-backend.dashsocial.com/brands/{brand_id}/campaigns/{campaign_id}/stats/overview', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://library-backend.dashsocial.com/brands/{brand_id}/campaigns/{campaign_id}/stats/overview",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://library-backend.dashsocial.com/brands/{brand_id}/campaigns/{campaign_id}/stats/overview"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://library-backend.dashsocial.com/brands/{brand_id}/campaigns/{campaign_id}/stats/overview")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://library-backend.dashsocial.com/brands/{brand_id}/campaigns/{campaign_id}/stats/overview")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"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
}
}
}{
"code": 123,
"errors": {},
"message": "<string>",
"status": "<string>"
}{
"code": 123,
"errors": {},
"message": "<string>",
"status": "<string>"
}Campaign
Get campaigns stats overview
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>'import requests
url = "https://library-backend.dashsocial.com/brands/{brand_id}/campaigns/{campaign_id}/stats/overview"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://library-backend.dashsocial.com/brands/{brand_id}/campaigns/{campaign_id}/stats/overview', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://library-backend.dashsocial.com/brands/{brand_id}/campaigns/{campaign_id}/stats/overview",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://library-backend.dashsocial.com/brands/{brand_id}/campaigns/{campaign_id}/stats/overview"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://library-backend.dashsocial.com/brands/{brand_id}/campaigns/{campaign_id}/stats/overview")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://library-backend.dashsocial.com/brands/{brand_id}/campaigns/{campaign_id}/stats/overview")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"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
}
}
}{
"code": 123,
"errors": {},
"message": "<string>",
"status": "<string>"
}{
"code": 123,
"errors": {},
"message": "<string>",
"status": "<string>"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
The Dash Social assigned ID of the brand.
The ID of the campaign object.
Required range:
x >= 0Query Parameters
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"
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
Show child attributes
Show child attributes
⌘I