DSP States

Track the availability status of products on Digital Service Providers.

Relationships: availabilities, dsp, product

Manage and monitor the current distribution status of products across various streaming platforms.

List DSP states

GET

https://api.idol.io/api/v2

/dsp-states

Track the availability status of products on Digital Service Providers

List DSP states › query Parameters

page[number]

integer · min: 1

Page number for pagination

Default: 1

page[size]

integer · min: 1 · max: 200

Number of items per page (max 200)

Default: 20

filter[product-id]

integer

Filter by product ID

filter[dsp-upload-identification-id]

integer

Filter by DSP upload identification ID

filter[current]

boolean

Filter by current status

List DSP states › Responses

Successful response

DspStateListResponse

DspStateResource[]

Array of resource objects (override with specific resource schema)

object[]

Related resources included in the response

PaginationMeta

PaginationLinks

GET/dsp-states

curl https://api.idol.io/api/v2/dsp-states \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "data": [
    {
      "type": "dsp-states",
      "id": "id",
      "attributes": {
        "is-available": true,
        "created-at": "2024-08-25T15:00:00Z",
        "updated-at": "2024-08-25T15:00:00Z"
      },
      "relationships": {
        "product": {
          "data": {
            "type": "type",
            "id": "id"
          },
          "links": {
            "self": "https://www.example.com/path/to/resource",
            "related": "https://www.example.com/path/to/resource"
          }
        },
        "dsp": {
          "data": {
            "type": "type",
            "id": "id"
          },
          "links": {
            "self": "https://www.example.com/path/to/resource",
            "related": "https://www.example.com/path/to/resource"
          }
        },
        "dsp-upload-identification": {
          "data": {
            "type": "type",
            "id": "id"
          },
          "links": {
            "self": "https://www.example.com/path/to/resource",
            "related": "https://www.example.com/path/to/resource"
          }
        },
        "availabilities": {
          "data": [
            {
              "type": "type",
              "id": "id"
            }
          ],
          "links": {
            "self": "https://www.example.com/path/to/resource",
            "related": "https://www.example.com/path/to/resource"
          },
          "meta": {}
        }
      },
      "links": {
        "self": "https://www.example.com/path/to/resource"
      }
    }
  ],
  "included": [
    {}
  ],
  "meta": {
    "record-count": 0,
    "page-count": 0
  },
  "links": {
    "first": "https://www.example.com/path/to/resource",
    "last": "https://www.example.com/path/to/resource",
    "prev": "https://www.example.com/path/to/resource",
    "next": "https://www.example.com/path/to/resource"
  }
}

json

application/vnd.api+json

Create a DSP state

POST

https://api.idol.io/api/v2

/dsp-states

Create a new DSP state to track product availability on a platform.

Required fields: product, available

Create a DSP state › Request Body

DspStateCreateRequest

DspStateResource · required

Create a DSP state › Responses

DSP state created successfully

DspStateResponse

DspStateResource

The primary resource object (override with specific resource schema)

object[]

Related resources included in the response

object

POST/dsp-states

curl https://api.idol.io/api/v2/dsp-states \
  --request POST \
  --header 'Content-Type: application/vnd.api+json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "data": {
    "type": "dsp-states",
    "id": "id",
    "attributes": {
      "is-available": true,
      "created-at": "2024-08-25T15:00:00Z",
      "updated-at": "2024-08-25T15:00:00Z"
    },
    "relationships": {
      "product": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      },
      "dsp": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      },
      "dsp-upload-identification": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      },
      "availabilities": {
        "data": [
          {
            "type": "type",
            "id": "id"
          }
        ],
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        },
        "meta": {}
      }
    },
    "links": {
      "self": "https://www.example.com/path/to/resource"
    }
  }
}'

Example Request Body

{
  "data": {
    "type": "dsp-states",
    "id": "id",
    "attributes": {
      "is-available": true,
      "created-at": "2024-08-25T15:00:00Z",
      "updated-at": "2024-08-25T15:00:00Z"
    },
    "relationships": {
      "product": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      },
      "dsp": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      },
      "dsp-upload-identification": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      },
      "availabilities": {
        "data": [
          {
            "type": "type",
            "id": "id"
          }
        ],
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        },
        "meta": {}
      }
    },
    "links": {
      "self": "https://www.example.com/path/to/resource"
    }
  }
}

json

Example Responses

{
  "data": {
    "type": "dsp-states",
    "id": "id",
    "attributes": {
      "is-available": true,
      "created-at": "2024-08-25T15:00:00Z",
      "updated-at": "2024-08-25T15:00:00Z"
    },
    "relationships": {
      "product": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      },
      "dsp": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      },
      "dsp-upload-identification": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      },
      "availabilities": {
        "data": [
          {
            "type": "type",
            "id": "id"
          }
        ],
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        },
        "meta": {}
      }
    },
    "links": {
      "self": "https://www.example.com/path/to/resource"
    }
  },
  "included": [
    {}
  ],
  "links": {
    "self": "https://www.example.com/path/to/resource"
  }
}

json

application/vnd.api+json

Get DSP state details

GET

https://api.idol.io/api/v2

/dsp-states/{id}

Retrieve a specific DSP state by ID

Get DSP state details › path Parameters

id

string · required

Resource ID

Get DSP state details › query Parameters

include

string

Comma-separated list of related resources to include

Get DSP state details › Responses

Successful response

DspStateResponse

DspStateResource

The primary resource object (override with specific resource schema)

object[]

Related resources included in the response

object

GET/dsp-states/{id}

curl https://api.idol.io/api/v2/dsp-states/:id \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "data": {
    "type": "dsp-states",
    "id": "id",
    "attributes": {
      "is-available": true,
      "created-at": "2024-08-25T15:00:00Z",
      "updated-at": "2024-08-25T15:00:00Z"
    },
    "relationships": {
      "product": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      },
      "dsp": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      },
      "dsp-upload-identification": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      },
      "availabilities": {
        "data": [
          {
            "type": "type",
            "id": "id"
          }
        ],
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        },
        "meta": {}
      }
    },
    "links": {
      "self": "https://www.example.com/path/to/resource"
    }
  },
  "included": [
    {}
  ],
  "links": {
    "self": "https://www.example.com/path/to/resource"
  }
}

json

application/vnd.api+json

DSP Upload Identifications Retails

Labelcamp API v2

DSP States

Track the availability status of products on Digital Service Providers.

Relationships: availabilities, dsp, product

Manage and monitor the current distribution status of products across various streaming platforms.

List DSP states

GET

https://api.idol.io/api/v2

/dsp-states

Track the availability status of products on Digital Service Providers

List DSP states › query Parameters

page[number]

integer · min: 1

Page number for pagination

Default: 1

page[size]

integer · min: 1 · max: 200

Number of items per page (max 200)

Default: 20

filter[product-id]

integer

Filter by product ID

filter[dsp-upload-identification-id]

integer

Filter by DSP upload identification ID

filter[current]

boolean

Filter by current status

List DSP states › Responses

Successful response

DspStateListResponse

DspStateResource[]

Array of resource objects (override with specific resource schema)

object[]

Related resources included in the response

PaginationMeta

PaginationLinks

GET/dsp-states

curl https://api.idol.io/api/v2/dsp-states \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "data": [
    {
      "type": "dsp-states",
      "id": "id",
      "attributes": {
        "is-available": true,
        "created-at": "2024-08-25T15:00:00Z",
        "updated-at": "2024-08-25T15:00:00Z"
      },
      "relationships": {
        "product": {
          "data": {
            "type": "type",
            "id": "id"
          },
          "links": {
            "self": "https://www.example.com/path/to/resource",
            "related": "https://www.example.com/path/to/resource"
          }
        },
        "dsp": {
          "data": {
            "type": "type",
            "id": "id"
          },
          "links": {
            "self": "https://www.example.com/path/to/resource",
            "related": "https://www.example.com/path/to/resource"
          }
        },
        "dsp-upload-identification": {
          "data": {
            "type": "type",
            "id": "id"
          },
          "links": {
            "self": "https://www.example.com/path/to/resource",
            "related": "https://www.example.com/path/to/resource"
          }
        },
        "availabilities": {
          "data": [
            {
              "type": "type",
              "id": "id"
            }
          ],
          "links": {
            "self": "https://www.example.com/path/to/resource",
            "related": "https://www.example.com/path/to/resource"
          },
          "meta": {}
        }
      },
      "links": {
        "self": "https://www.example.com/path/to/resource"
      }
    }
  ],
  "included": [
    {}
  ],
  "meta": {
    "record-count": 0,
    "page-count": 0
  },
  "links": {
    "first": "https://www.example.com/path/to/resource",
    "last": "https://www.example.com/path/to/resource",
    "prev": "https://www.example.com/path/to/resource",
    "next": "https://www.example.com/path/to/resource"
  }
}

json

application/vnd.api+json

Create a DSP state

POST

https://api.idol.io/api/v2

/dsp-states

Create a new DSP state to track product availability on a platform.

Required fields: product, available

Create a DSP state › Request Body

DspStateCreateRequest

DspStateResource · required

Create a DSP state › Responses

DSP state created successfully

DspStateResponse

DspStateResource

The primary resource object (override with specific resource schema)

object[]

Related resources included in the response

object

POST/dsp-states

curl https://api.idol.io/api/v2/dsp-states \
  --request POST \
  --header 'Content-Type: application/vnd.api+json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "data": {
    "type": "dsp-states",
    "id": "id",
    "attributes": {
      "is-available": true,
      "created-at": "2024-08-25T15:00:00Z",
      "updated-at": "2024-08-25T15:00:00Z"
    },
    "relationships": {
      "product": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      },
      "dsp": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      },
      "dsp-upload-identification": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      },
      "availabilities": {
        "data": [
          {
            "type": "type",
            "id": "id"
          }
        ],
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        },
        "meta": {}
      }
    },
    "links": {
      "self": "https://www.example.com/path/to/resource"
    }
  }
}'

Example Request Body

{
  "data": {
    "type": "dsp-states",
    "id": "id",
    "attributes": {
      "is-available": true,
      "created-at": "2024-08-25T15:00:00Z",
      "updated-at": "2024-08-25T15:00:00Z"
    },
    "relationships": {
      "product": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      },
      "dsp": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      },
      "dsp-upload-identification": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      },
      "availabilities": {
        "data": [
          {
            "type": "type",
            "id": "id"
          }
        ],
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        },
        "meta": {}
      }
    },
    "links": {
      "self": "https://www.example.com/path/to/resource"
    }
  }
}

json

Example Responses

{
  "data": {
    "type": "dsp-states",
    "id": "id",
    "attributes": {
      "is-available": true,
      "created-at": "2024-08-25T15:00:00Z",
      "updated-at": "2024-08-25T15:00:00Z"
    },
    "relationships": {
      "product": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      },
      "dsp": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      },
      "dsp-upload-identification": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      },
      "availabilities": {
        "data": [
          {
            "type": "type",
            "id": "id"
          }
        ],
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        },
        "meta": {}
      }
    },
    "links": {
      "self": "https://www.example.com/path/to/resource"
    }
  },
  "included": [
    {}
  ],
  "links": {
    "self": "https://www.example.com/path/to/resource"
  }
}

json

application/vnd.api+json

Get DSP state details

GET

https://api.idol.io/api/v2

/dsp-states/{id}

Retrieve a specific DSP state by ID

Get DSP state details › path Parameters

id

string · required

Resource ID

Get DSP state details › query Parameters

include

string

Comma-separated list of related resources to include

Get DSP state details › Responses

Successful response

DspStateResponse

DspStateResource

The primary resource object (override with specific resource schema)

object[]

Related resources included in the response

object

GET/dsp-states/{id}

curl https://api.idol.io/api/v2/dsp-states/:id \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "data": {
    "type": "dsp-states",
    "id": "id",
    "attributes": {
      "is-available": true,
      "created-at": "2024-08-25T15:00:00Z",
      "updated-at": "2024-08-25T15:00:00Z"
    },
    "relationships": {
      "product": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      },
      "dsp": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      },
      "dsp-upload-identification": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      },
      "availabilities": {
        "data": [
          {
            "type": "type",
            "id": "id"
          }
        ],
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        },
        "meta": {}
      }
    },
    "links": {
      "self": "https://www.example.com/path/to/resource"
    }
  },
  "included": [
    {}
  ],
  "links": {
    "self": "https://www.example.com/path/to/resource"
  }
}

json

application/vnd.api+json

DSP Upload Identifications Retails