Skip to main content

Report usage

POST 

https://partner-content-api.epidemicsound.com/v0/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.

Request

Body

Usage report

    eventType string

    Possible values: [EXPORTED]

    platform stringrequired

    Possible values: [YOUTUBE, TWITTER, TWITCH, FACEBOOK, INSTAGRAM, TIKTOK, OTHER, LOCAL]

    trackIds string[]required
    other stringnullable

Responses

Usage report response

Schema

    message stringrequired

    Human readable message

    errors

    object[]

  • Array [

  • key stringrequired

    Error key

    messages string[]required

    Error messages

  • ]

Authorization: http

name: UserAuthtype: httpdescription: User authentication is handled with short lived user access tokens.
 Use a partner token to request these tokens.
 The access token is of JWT format and should be passed in a header with your API requests:
 
 > **Example Header:** `Authorization: Bearer a-user-token`scheme: bearer
curl -L 'https://partner-content-api.epidemicsound.com/v0/usage' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
-d '{
"eventType": "EXPORTED",
"platform": "YOUTUBE",
"trackIds": [
"string"
],
"other": "string"
}'
Request Collapse all
Base URL
https://partner-content-api.epidemicsound.com
Auth
Body
{
  "eventType": "EXPORTED",
  "platform": "YOUTUBE",
  "trackIds": [
    "string"
  ],
  "other": "string"
}
ResponseClear

Click the Send API Request button above and see the response here!