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.
- application/json
Request Body
Analytics report
events object[] required
Array [userId stringtimestamp date-timeuserConnected boolean nullableanalyticsEvent object
- oneOf
- TrackPreviewedEvent
- TrackDownloadedEvent
- TracksExportedEvent
trackId stringtype stringPossible values: [
trackPreviewed
]trackId stringformat stringPossible values: [
mp3
,hls
,hls_with_cookie
]quality stringPossible values: [
normal
,high
]type stringPossible values: [
trackDownloaded
]trackIds string[]platform stringPossible values: [
YOUTUBE
,TWITTER
,TWITCH
,FACEBOOK
,INSTAGRAM
,TIKTOK
,OTHER
,LOCAL
]type stringPossible values: [
tracksExported
]]
- 200
- 400
- 401
- 429
Usage report response
- application/json
- Schema
- Example (from schema)
- Example
Schema
- batchId string required
- eventsCount int32 required
{
"batchId": "string",
"eventsCount": 0
}
{
"batchId": "12345",
"eventsCount": 10
}
Bad request.
- application/json
- Schema
- Example (from schema)
- Example
Schema
- message string required
Human readable message
errors object[]
Array [key string requiredError key
messages string[] requiredError 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 requiredError key
messages string[] requiredError 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 requiredError key
messages string[] requiredError messages
]
{
"message": "string",
"errors": [
{
"key": "string",
"messages": [
"string"
]
}
]
}
{
"message": "Rate limit exceeded"
}