Measure the impact of user-generated content and creator posts that mention your brand. Pull total performance metrics for brand mentions across Instagram and TikTok to quantify your UGC value.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
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
| Metric Name | Description | Metric API Name |
|---|---|---|
| UGC - Avg. EMV | The average earned media value of posts featuring you. EMV is calculated by factoring in the channel, audience size, content type, engagement and current market values for comparable posts. | AVG_EMV |
| Total Social Impact - All Posts | TSI is like a market index for your brand’s social presence - it brings together everything your brand does across social to reveal the strength of your total presence. It rolls up all your channels, content, and engagement into one score that grows over time, giving you a clear view of performance and momentum. | TOTAL_TSI |
| UGC - Avg. Effectiveness | The average percentage of people who saw posts featuring you and engaged with them | UGC_AVG_EFFECTIVENESS_CONNECTED |
| UGC - Avg. Effectiveness | The average percentage of people who saw posts featuring you and engaged with them. If connected creators are included in this report, their true reach and engagements will be used to calculate their Avg. Effectiveness. | UGC_AVG_EFFECTIVENESS_PUBLIC |
| UGC - Avg. Engagement Rate (Followers) | The average percentage of people who engaged with posts featuring you, based on follower count. This metric uses Likes. If Likes are hidden on Instagram, they will show as 0 in Dash Social. If connected creators are included in this report, their true engagements will be used to calculate their engagement rate. | UGC_AVG_ENGAGEMENT_RATE_FOLLOWERS |
| UGC - Avg. Engagement Rate (Views) | The average percentage of people who engaged with posts featuring you, based on the number of people who viewed it. This metric uses Likes. If Likes are hidden on Instagram, they will show as 0 in Dash Social. | UGC_AVG_ENGAGEMENT_RATE_VIEWS |
| UGC - Avg. Estimated Reach | The estimated average number of unique accounts that saw posts featuring you. If connected creators are included in this report, their true reach is included with unconnected creators’ estimated reach. | UGC_AVG_ESTIMATED_REACH |
| UGC - Avg. Reach | The average number of unique accounts that saw posts featuring you | UGC_AVG_REACH |
| UGC - Avg. Watch Time | The average time that posts featuring you were played during a single viewing | UGC_AVG_WATCH_TIME |
| UGC - Comments | The number of comments on posts featuring you | UGC_COMMENTS |
| UGC - EMV | The earned media value of the creator’s content. EMV is calculated by factoring in the channel, audience size, content type, engagement and current market values for comparable posts. | UGC_EMV |
| UGC - Engagements | The total number of engagements on posts featuring you. If Likes are hidden on Instagram, they will show as 0 in Dash Social. | UGC_ENGAGEMENTS_CONNECTED |
| UGC - Engagements | The total number of engagements on posts featuring you. If Likes are hidden on Instagram, they will show as 0 in Dash Social. If connected creators are included in this report, their true engagements is included with the unconnected creators’ engagements. | UGC_ENGAGEMENTS_PUBLIC |
| UGC - Estimated Reach | The estimated number of unique accounts who saw posts that mentioned or tagged you | UGC_ESTIMATED_REACH |
| UGC - Followers Gained | The estimated number of followers your brand has gained from posts featuring you | UGC_FOLLOWERS_GAINED |
| UGC - Likes | The number of likes received on posts featuring you | UGC_LIKES |
| UGC - Mentions | The total number of times you were mentioned by other accounts by including your @username in their caption | UGC_MENTIONS |
| UGC - Number of Posts | The total number of posts that mentioned or tagged you | UGC_NUMBER_OF_POSTS |
| UGC - Photo Tags | The total number of times you were tagged by other accounts by using a photo tag on the post | UGC_PHOTO_TAGS |
| UGC - Reach | The number of unique accounts who saw posts featuring you | UGC_REACH |
| UGC - Saves | The number of times posts featuring you were saved | UGC_SAVES |
| UGC - Shares | The number of times posts featuring you were shared | UGC_SHARES |
| UGC - Time Watched | The amount of time videos featuring you were played during a single viewing | UGC_TIME_WATCHED |
| UGC - Views | The amount of times videos featuring you were played or replayed for 1ms or more. Replays are counted after the initial play in the same video session. | UGC_VIEWS |
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