Skip to content

Dsp

A DSP (Digital Service Provider) is a streaming/download platform (Spotify, Apple Music, Amazon, etc.). This resource is read-only and exposes only the DSP name. It also appears as a dsps relationship on the rights resource.


Lists Dsps

GET https://domain.com/api/v1/dsps

Headers

Name Type Description
Authorization* String Bearer \
Content-Type* String application/vnd.api+json

Response — 200 OK

{
  "data": [
    {
      "type": "dsps",
      "id": "1",
      "attributes": {
        "name": "Spotify"
      },
      "links": {
        "self": "https://domain.com/api/v1/dsps/1"
      }
    },
    {
      "type": "dsps",
      "id": "2",
      "attributes": {
        "name": "Apple Music"
      },
      "links": {
        "self": "https://domain.com/api/v1/dsps/2"
      }
    }
  ],
  "meta": {
    "page": {
      "currentPage": 1,
      "from": 1,
      "lastPage": 5,
      "perPage": 20,
      "to": 2,
      "total": 10
    }
  },
  "jsonapi": {
    "version": "1.0"
  },
  "links": {
    "first": "https://domain.com/api/v1/dsps?page[number]=1&page[size]=20",
    "last": "https://domain.com/api/v1/dsps?page[number]=1&page[size]=20"
  }
}

Filters

Filter Example
Name /dsps?filter[name]=Spotify
ID /dsps?filter[id]=1,3,7

Get Dsp

GET https://domain.com/api/v1/dsps/:id

Path Parameters

Name Type Description
id* Number DSP ID

Headers

Name Type Description
Authorization* String Bearer \
Content-Type* String application/vnd.api+json

Response — 200 OK

{
  "data": {
    "type": "dsps",
    "id": "<ID>",
    "attributes": {
      "name": "Spotify"
    },
    "links": {
      "self": "https://domain.com/api/v1/dsps/<ID>"
    }
  },
  "jsonapi": {
    "version": "1.0"
  },
  "links": {
    "self": "https://domain.com/api/v1/dsps/<ID>"
  }
}

Response — 404 Not Found

{
  "jsonapi": {
    "version": "1.0"
  },
  "errors": [
    {
      "status": "404",
      "title": "Not Found"
    }
  ]
}