Report usage
POSThttps://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
- application/json
Body
Usage report
Possible values: [EXPORTED
]
Possible values: [YOUTUBE
, TWITTER
, TWITCH
, FACEBOOK
, INSTAGRAM
, TIKTOK
, OTHER
, LOCAL
]
Responses
- 200
- 400
- 401
- 429
Usage report response
- application/json
- Schema
- Example (from schema)
- Example
Schema
Human readable message
errors
object[]
{
"message": "string",
"errors": [
{
"key": "string",
"messages": [
"string"
]
}
]
}
{
"message": "Ok"
}
Bad request.
- application/json
- Schema
- Example (from schema)
- Example
Schema
Human readable message
errors
object[]
{
"message": "string",
"errors": [
{
"key": "string",
"messages": [
"string"
]
}
]
}
{
"message": "Bad request"
}
Unauthorized. Most likely your access token has expired.
- application/json
- Schema
- Example (from schema)
- Example
Schema
Human readable message
errors
object[]
{
"message": "string",
"errors": [
{
"key": "string",
"messages": [
"string"
]
}
]
}
{
"message": "Invalid credentials"
}
Rate limit exceeded.
- application/json
- Schema
- Example (from schema)
- Example
Schema
Human readable message
errors
object[]
{
"message": "string",
"errors": [
{
"key": "string",
"messages": [
"string"
]
}
]
}
{
"message": "Rate limit exceeded"
}
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
- python
- nodejs
- CURL
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"
}'