Pull aggregated ad campaign metrics across Meta Ads and TikTok Ads. Use the data to monitor and compare ad campaign performance across brands.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.
Use cases
Tracking ad campaign performance manually across platforms wastes hours each week. Social advertising metric reports give you cross-platform ad performance benchmarks instantly.Monitor campaign ROI
Compare ad spend and performance metrics across Meta and TikTok campaigns to optimize budget allocation
Track multi-brand performance
Monitor ad campaign effectiveness across multiple brands from a single dashboard
Identify top performers
Analyze which campaigns drive the most clicks, conversions, and engagement across platforms
Before you start
Prerequisites:- API Key - Your authentication token - Get your API key from the API Quickstart.
- Brand ID - Your brand’s unique ID
- Connected Ad Accounts - Meta Ads and/or TikTok Ads accounts connected in Dash Social
- Meta Ads
- TikTok Ads
Test in the dashboard first
Preview ad campaign metrics in the Dash Social Dashboard to understand the data structure before pulling via API.Implementation
Step 1: Get ad account IDs
Get the ad account IDs for your connected advertising accounts. Each platform has a different endpoint.For Meta Ads
Send a GET request:{brand_id} with your brand ID (e.g., 144).
For TikTok Ads
Send a GET request:{brand_id} with your brand ID (e.g., 144).
Sample response (both platforms):
id value. You’ll use these in Step 2.
Compare across platforms
To compare multiple platforms, call both endpoints separately to get ad account IDs for Meta and TikTok.Step 2: Get ad campaigns
Retrieve the ad campaigns under each ad account. Each platform has a different endpoint.For Meta Ads
Send a PUT request:For TikTok Ads
Send a PUT request:source_ad_account_id and source_campaign_id value. Format as comma-separated values for the report API:
- Ad account IDs:
1368643043296927,7113956961980284930 - Campaign IDs:
120236587787680490,120236587787680491
Step 3: Map your report parameters
Map the available parameters before making the API call:Step 4: Request the metric report
Send a GET request using the parameters from Step 3. This example gets link clicks for Meta Ads campaigns:Compare multiple platforms
Make separate requests for each channel:META_ADS, TIKTOK_ADS. Combine results in your dashboard or analytics tool.Step 5: Interpret the response
The response includes data for each ad campaign.Response structure
Each campaign includes:data_type:CAMPAIGNcampaign_name: Name of the ad campaignsource_ad_account_id: Ad account IDsource_campaign_id: Campaign IDmetrics: Object containing requested metricsvalue: Metric total for the reporting periodcontext: Metric total for the comparison periodcontext_change: Decimal representing percent change (e.g.,0.24= +24%,-0.09= -9%)
Metrics
- Meta Ads
- TikTok Ads
| Metric Name | Description | Metric API Name |
|---|---|---|
| Clicks (All) - Ads | The total number of times the ads in your selected campaign were clicked during the Reporting Period | CLICKS |
| CTR - Ads | The percentage of times people clicked your ads after seeing them during the Reporting Period. CTR = Total Clicks / Impressions | CLICK_THROUGH_RATE |
| Conversion Rate - Ads | The percentage of people who saw the ad and performed the desired action | CONVERSION_RATE |
| CPC - Ads | The average cost per click on your social ads during the Reporting Period.CPC = Spend / Total Clicks | COST_PER_CLICK |
| CPM - Ads | The average cost per 1,000 impressions on your selected ad campaign during the Reporting Period. CPM = Total Spend / Impressions | COST_PER_MILE |
| Engagements - Ads | The total number of engagements on all ads within your selected campaign during the Reporting Period | ENGAGEMENTS |
| Engagement Rate - Ads | The total percentage of users who engaged with your selected campaign after seeing an ad during the Reporting Period. Engagement Rate = Total Engagements / Impressions | ENGAGEMENT_RATE |
| Frequency - Ads | The average number of times users saw ads in your campaign during the Reporting Period | FREQUENCY |
| Impressions - Ads | The total number of impressions the ads in your selected campaign received during the Reporting Period | IMPRESSIONS |
| Link Clicks - Ads | The total number of times links on the ads in your selected campaign were clicked during the Reporting Period | LINK_CLICKS |
| Page Engagements - Ads | The total number of engagements your page and its posts received from your ads during the Reporting Period | PAGE_ENGAGEMENTS |
| Reach - Ads | The total number of unique accounts that saw ads within your selected campaign during the Reporting Period. | REACH |
| ROAS - Ads | The total return on ad spend for your selected campaign, as provided by Meta.ROAS = Calculated Purchase Conversion Value / Amount Spent | RETURN_ON_AD_SPEND |
| Amount Spent - Ads | The average cost per click on your social ads during the Reporting Period.CPC = Spend / Total Clicks | TOTAL_SPENT |
| Video Views - Ads | The total number of times videos in your selected ad campaign were viewed for over 3 seconds during the Reporting Period | VIDEO_VIEWS |
| Web Conversions - Ads | The estimated number of conversions your selected ad campaign received during the Reporting Period, as measured by the Meta Pixel installed on your website | WEB_CONVERSIONS |
Next steps
With your ad campaign metrics, you can:- Build performance dashboards - Compare campaign performance across brands and platforms
- Track ROI trends - Query monthly to spot campaign effectiveness changes
- Optimize ad spend - Compare metrics across campaigns to identify top performers
- Inform budget allocation - Use performance data to guide investment decisions across platforms