Use cases
Measuring UGC impact across platforms is hard when data is scattered. Metric reports give you total performance numbers for all brand mentions in one request.Calculate creator ROI
Measure total reach and engagement from influencer content to calculate partnership value and justify budgets
Track UGC campaigns
Pull total comments, likes, and shares during campaign periods to measure impact and report to stakeholders
Compare platform performance
Benchmark UGC engagement across Instagram, Stories, and TikTok to optimize your content strategy
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.
- Instagram Stories
- TikTok
Test in the UI first: Create a Dashboard in the Dash Social UI and configure your Earned report there. This previews the metrics and validates your filters before writing code.
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 pulls total comments on Instagram UGC mentioning brand144 from August 10-20, with July as the comparison period.
Multiple metrics
Request multiple metrics in a single call by separating them with commas (e.g.,UGC_COMMENTS,UGC_LIKES,UGC_REACH).Sample response
The API returns totals for each metric, organized by brand and channel. Thevalue field shows your reporting period total. The context field shows your comparison period total.
Understanding the response: Metrics are organized by brand ID and channel. Brand
144 (“sunny.today”) received 1 comment on Instagram UGC during the reporting period (August 10-20), down from 6 comments in the context period (July 1-31). The context_change value of -0.833 indicates an 83.3% decrease.Metrics
- Instagram
- Instagram Stories
- TikTok
Next steps
You now have a JSON response with total UGC performance metrics per brand and platform. Use this data to:- Calculate ROI - Measure the value of creator partnerships and influencer campaigns
- Track campaigns - Monitor UGC performance during specific campaign periods
- Compare platforms - Analyze which channels drive the most UGC engagement