CollectionsResponseData

collections object[]required

Array [

oneOf

ErrorResponse

successbooleanrequired

Possible values: [false]

messagestring

Human-readable message describing the error

failureCodeFailureCode (string)required

Possible values: [GEOGRAPHICALLY_BLOCKED, ENDPOINT_NOT_FOUND, AUTHENTICATION_FAILED, VALIDATION_ERROR, SERVICE_UNAVAILABLE, INTERNAL_ERROR, ACR_CLOUD_ERROR, ACR_CLOUD_CONFIG_ERROR, NO_STREAMING_RIGHTS, CLIP_NOT_FOUND, TRACK_NOT_FOUND, COLLECTION_NOT_FOUND, INVALID_PARAMETERS, MISSING_HEADERS, NETWORK_ERROR]

errorDataobject

Additional error context data

MOD2

successbooleanrequired

Possible values: [true]

data object

collectionIdintegerrequired

Possible values: >= 1

collectionNamestringrequired

descriptionstringrequired

publishedOndate-timenullable

ratingstringrequired

Possible values: [G, PG, PG-13, R, NC17, unknown]

explicitbooleanrequired

True if any track in the collection is explicit

clips object[]required

Array [

clipIdintegerrequired

Possible values: >= 1

trackIdintegerrequired

Possible values: >= 1

artworkPreSignedUrluri

artworkThumbnailUrlurinullable

URL for a small composite thumbnail of this clip's artwork. May be null when no artwork is available.

titlestringrequired

artiststringrequired

albumstringrequired

durationnumberrequired

Possible values: >= 0

preSignedUrlurirequired

preSignedUrlExpiresdate-time

encodingstringrequired

bitrateintegerrequired

Possible values: >= 1

explicitnessExplicitness (string)required

Explicitness status of the track

Possible values: [explicit, clean, censored, unknown]

createDatedate-timerequired

isrcstring

]

]

CollectionsResponseData

{
  "collections": [
    {
      "success": false,
      "message": "string",
      "failureCode": "GEOGRAPHICALLY_BLOCKED",
      "errorData": {}
    },
    {
      "success": true,
      "data": {
        "collectionId": 0,
        "collectionName": "string",
        "description": "string",
        "publishedOn": "2024-07-29T15:51:28.071Z",
        "rating": "G",
        "explicit": true,
        "clips": [
          {
            "clipId": 0,
            "trackId": 0,
            "artworkPreSignedUrl": "string",
            "artworkThumbnailUrl": "string",
            "title": "string",
            "artist": "string",
            "album": "string",
            "duration": 0,
            "preSignedUrl": "string",
            "preSignedUrlExpires": "2024-07-29T15:51:28.071Z",
            "encoding": "string",
            "bitrate": 0,
            "explicitness": "explicit",
            "createDate": "2024-07-29T15:51:28.071Z",
            "isrc": "string"
          }
        ]
      }
    }
  ]
}