Skip to main content
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.

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.
See API Quickstart for more details. Supported platforms This report supports these UGC channels:
  • Instagram
  • Instagram Stories
  • TikTok
About earned reports Earned reports track user-generated content that mentions or tags your brand. Unlike Owned reports (content you published) or Competitor reports (content from competitors), Earned reports measure UGC performance.
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.
One channel per request: You cannot query multiple UGC channels in the same request. Make separate API calls for each channel.

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 brand 144 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).
Date format matters: Always use YYYY-MM-DD format for dates (e.g., 2025-08-10). Other formats will cause errors.
One channel per request: Make separate API calls for each channel (INSTAGRAM_UGC, INSTAGRAM_STORIES_UGC, TIKTOK_UGC).

Sample response

The API returns totals for each metric, organized by brand and channel. The value 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

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
Related guides: