v2

latestOpenAPI 3.0.12026-08-074878134.7 KB
Reporting

Report usage

The usage endpoint lets you report when a user exports their content to social media or downloads the content file to their device. You can specify which platform (YouTube, Twitch, Instagram, Facebook, TikTok, Twitter or Other) they export the file to. Use the platform local if the user downloads the content to their device. This data is used for attribution and analytics purposes as well as to improve personalization.

post/v0/usage

Request body

eventType'EXPORTED'
platform'YOUTUBE' | 'TWITTER' | 'TWITCH' | 'FACEBOOK' | 'INSTAGRAM' | 'TIKTOK' | 'OTHER' | 'LOCAL' required
trackIdsstring[] required
otherstring nullable

Response

Usage report response

messagestring required

Human readable message