Bulk report usage

POST 
/v0/analytics/report

This endpoint should be used when you want to bulk report events to Epidemic Sound. We currently support the following events: trackPreviewed, trackDownloaded and tracksExported. Note that the limit for number of events per request is limited to 100. Also note that for events containing the field trackIds, the limit for number of trackIds per event is 50. Events may not contain a timestamp older than 7 days ago.

Request

application/json

Body

Analytics report

events

object[]

required

Array [

userId string

timestamp date-time

userConnected booleannullable

analyticsEvent

object

oneOf

TrackPreviewedEvent

trackId string

type string

Possible values: [trackPreviewed]

TrackDownloadedEvent

trackId string

format string

Possible values: [mp3, hls, hls_with_cookie]

quality string

Possible values: [normal, high]

type string

Possible values: [trackDownloaded]

TracksExportedEvent

trackIds string[]

platform string

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

type string

Possible values: [tracksExported]

]

Responses

200

Usage report response

application/json

Schema

Schema

batchId stringrequired
eventsCount int32required

Example (from schema)

{
  "batchId": "string",
  "eventsCount": 0
}

Example

{
  "batchId": "12345",
  "eventsCount": 10
}

400

Bad request.

application/json

Schema

Schema

message stringrequired

Human readable message

errors

object[]

Array [

key stringrequired

Error key

messages string[]required

Error messages

]

Example (from schema)

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

Example

{
  "message": "Bad request"
}

401

Unauthorized. Most likely your access token has expired.

application/json

Schema

Schema

message stringrequired

Human readable message

errors

object[]

Array [

key stringrequired

Error key

messages string[]required

Error messages

]

Example (from schema)

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

Example

{
  "message": "Invalid credentials"
}

429

Rate limit exceeded.

application/json

Schema

Schema

message stringrequired

Human readable message

errors

object[]

Array [

key stringrequired

Error key

messages string[]required

Error messages

]

Example (from schema)

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

Example

{
  "message": "Rate limit exceeded"
}

Loading...