Skip to content

DspUploadIdentification

A DSP upload identification is a configured delivery channel pairing a DSP with a distributor. It carries the DDEX sender identity and connection parameters used to deliver to that DSP. This resource is read-only and scoped to the authenticated user's group distributors.

Lists DspUploadIdentifications

GET https://domain.com/api/v1/dsp-upload-identifications

Headers

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

Response — 200 OK

{
  "data": [
    {
      "type": "dsp-upload-identifications",
      "id": "<ID>",
      "attributes": {
        "sender-name": "sender-name",
        "sender-id": "sender-id",
        "status": "active",
        "dsp-id": 1,
        "dsp-name": "YouTube Art Track",
        "ddex-version": "382",
        "created-at": "2023-07-31T16:52:42.000000Z",
        "updated-at": "2023-07-31T16:52:42.000000Z"
      },
      "relationships": {
        "dsp": {
          "links": {
            "related": "https://domain.com/api/v1/dsp-upload-identifications/<ID>/dsp",
            "self": "https://domain.com/api/v1/dsp-upload-identifications/<ID>/relationships/dsp"
          }
        },
        "distributor": {
          "links": {
            "related": "https://domain.com/api/v1/dsp-upload-identifications/<ID>/distributor",
            "self": "https://domain.com/api/v1/dsp-upload-identifications/<ID>/relationships/distributor"
          }
        }
      },
      "links": {
        "self": "https://domain.com/api/v1/dsp-upload-identifications/<ID>"
      }
    }
  ],
  "meta": {
    "page": {
      "currentPage": 1,
      "from": 1,
      "lastPage": 1,
      "perPage": 20,
      "to": 1,
      "total": 1
    }
  },
  "jsonapi": {
    "version": "1.0"
  },
  "links": {
    "first": "https://domain.com/api/v1/dsp-upload-identifications?page[number]=1&page[size]=20",
    "last": "https://domain.com/api/v1/dsp-upload-identifications?page[number]=1&page[size]=20"
  }
}

Filters

Filter Example
ID /dsp-upload-identifications?filter[id]=1
DSP ID /dsp-upload-identifications?filter[dsp-id]=12
DSP name /dsp-upload-identifications?filter[dsp-name]=Spotify

Note: Prefer filter[dsp-id] for reliable matching.

Get DspUploadIdentification

GET https://domain.com/api/v1/dsp-upload-identifications/:id

Path Parameters

Name Type Description
id* Number DspUploadIdentification ID

Headers

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

Response — 200 OK

{
  "data": {
    "type": "dsp-upload-identifications",
    "id": "<ID>",
    "attributes": {
      "sender-name": "sender-name",
      "sender-id": "sender-id",
      "status": "active",
      "dsp-id": 1,
      "dsp-name": "YouTube Art Track",
      "ddex-version": "382",
      "created-at": "2023-07-31T16:52:42.000000Z",
      "updated-at": "2023-07-31T16:52:42.000000Z"
    },
    "relationships": {
      "dsp": {
        "links": {
          "related": "https://domain.com/api/v1/dsp-upload-identifications/<ID>/dsp",
          "self": "https://domain.com/api/v1/dsp-upload-identifications/<ID>/relationships/dsp"
        }
      },
      "distributor": {
        "links": {
          "related": "https://domain.com/api/v1/dsp-upload-identifications/<ID>/distributor",
          "self": "https://domain.com/api/v1/dsp-upload-identifications/<ID>/relationships/distributor"
        }
      }
    },
    "links": {
      "self": "https://domain.com/api/v1/dsp-upload-identifications/<ID>"
    }
  },
  "jsonapi": {
    "version": "1.0"
  },
  "links": {
    "self": "https://domain.com/api/v1/dsp-upload-identifications/<ID>"
  }
}

Response — 404 Not Found

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