Report usage

POST /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.

application/json

Request Body

Usage report

eventType string
Possible values: [EXPORTED]
platform string required
Possible values: [YOUTUBE, TWITTER, TWITCH, FACEBOOK, INSTAGRAM, TIKTOK, OTHER, LOCAL]
trackIds string[] required
other string nullable

Responses

Usage report response

application/json

Schema
Example (from schema)
Example

Schema

message string required
Human readable message
errors object[]
Array [
key string required
Error key
messages string[] required
Error messages
]

{
  "message": "string",
  "errors": [
    {
      "key": "string",
      "messages": [
        "string"
      ]
    }
  ]
}

{
  "message": "Ok"
}

Bad request.

application/json

Schema
Example (from schema)
Example

Schema

message string required
Human readable message
errors object[]
Array [
key string required
Error key
messages string[] required
Error messages
]

{
  "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

message string required
Human readable message
errors object[]
Array [
key string required
Error key
messages string[] required
Error messages
]

{
  "message": "string",
  "errors": [
    {
      "key": "string",
      "messages": [
        "string"
      ]
    }
  ]
}

{
  "message": "Invalid credentials"
}

Rate limit exceeded.

application/json

Schema
Example (from schema)
Example

Schema

message string required
Human readable message
errors object[]
Array [
key string required
Error key
messages string[] required
Error messages
]

{
  "message": "string",
  "errors": [
    {
      "key": "string",
      "messages": [
        "string"
      ]
    }
  ]
}

{
  "message": "Rate limit exceeded"
}