DspUploadIdentification
List DspUploadIdentifications
GET https://api.idol.io/api/v2/dsp-upload-identifications
Headers
Name
Type
Description
Authorization*
string
Bearer <token>
Content-Type*
string
application/vnd.api+json
{
"data": [
{
"id": "<ID>",
"type": "dsp-upload-identifications",
"links": {
"self": "https://api.idol.io/api/v2/dsp-upload-identifications/<ID>"
},
"attributes": {
"created-at": "2020-12-13T18:50:17.000+01:00",
"updated-at": "2023-05-30T11:37:19.320+02:00",
"dsp-name": "Apple",
"options": [
{
"name": "custom_vendor_id",
"label": "Custom Vendor ID",
"hint": "If you have trouble uploading/updating an album uploaded via another distributor or the Apple Producer, you can fill this field. You will find it directly on your Apple Producer",
"format": null,
"type": "string",
"value": null
},
{
"name": "preorder_only",
"label": "Number of Last Tracks as Preorder",
"hint": "You can specify up to 50% of the album tracks (or videos) as Instant-Gratification tracks. Purchasers who pre-order the album can download the tracks immediately",
"format": null,
"type": "integer",
"value": null
},
{
"name": "itunes_preorder_price_code_id",
"label": "Price Code During Preorder Period",
"hint": null,
"format": null,
"type": "integer",
"value": [
{
"value": 1,
"name": "P1 - 0,99€"
},
{
"value": 2,
"name": "P2 - 1,99€"
},
{
"value": 3,
"name": "P3 - 2,99€"
},
{
"value": 4,
"name": "P4 - 3,99€"
},
{
"value": 5,
"name": "P5 - 4,99€"
},
{
"value": 6,
"name": "P6 - 5,99€"
},
{
"value": 7,
"name": "P7 - 6,99€"
},
{
"value": 8,
"name": "P8 - 7,99€"
},
{
"value": 9,
"name": "P9 - 8,99€"
},
{
"value": 10,
"name": "P0 - 9,99€"
}
]
},
"relationships": {
"offers": {
"links": {
"self": "https://api.idol.io/api/v2/dsp-upload-identifications/<ID>/relationships/offers",
"related": "https://api.idol.io/api/v2/dsp-upload-identifications/<ID>/offers"
}
},
"dsp": {
"links": {
"self": "https://api.idol.io/api/v2/dsp-upload-identifications/<ID>/relationships/dsp",
"related": "https://api.idol.io/api/v2/dsp-upload-identifications/<ID>/dsp"
},
"data": {
"type": "dsps",
"id": "<ID>"
}
}
}
},
{
"id": "<ID>",
"type": "dsp-upload-identifications",
"links": {
"self": "https://api.idol.io/api/v2/dsp-upload-identifications/<ID>"
},
"attributes": {
"created-at": "2023-08-01T10:18:29.000+02:00",
"updated-at": "2023-05-31T14:42:40.042+02:00",
"dsp-name": "Amazon"
},
"relationships": {
"offers": {
"links": {
"self": "https://api.idol.io/api/v2/dsp-upload-identifications/<ID>/relationships/offers",
"related": "https://api.idol.io/api/v2/dsp-upload-identifications/<ID>/offers"
}
},
"dsp": {
"links": {
"self": "https://api.idol.io/api/v2/dsp-upload-identifications/<ID>/relationships/dsp",
"related": "https://api.idol.io/api/v2/dsp-upload-identifications/<ID>/dsp"
},
"data": {
"type": "dsps",
"id": "<ID>"
}
}
}
},
{
"id": "<ID>",
"type": "dsp-upload-identifications",
"links": {
"self": "https://api.idol.io/api/v2/dsp-upload-identifications/<ID>"
},
"attributes": {
"created-at": "2022-05-03T09:25:22.757+02:00",
"updated-at": "2022-03-17T15:51:27.272+01:00",
"dsp-name": "YouTube Content ID"
},
"relationships": {
"offers": {
"links": {
"self": "https://api.idol.io/api/v2/dsp-upload-identifications/<ID>/relationships/offers",
"related": "https://api.idol.io/api/v2/dsp-upload-identifications/<ID>/offers"
}
},
"dsp": {
"links": {
"self": "https://api.idol.io/api/v2/dsp-upload-identifications/<ID>/relationships/dsp",
"related": "https://api.idol.io/api/v2/dsp-upload-identifications/<ID>/dsp"
},
"data": {
"type": "dsps",
"id": "<ID>"
}
}
}
}
],
"meta": {
"record-count": 3,
"page-count": 1
},
"links": {
"first": "https://api.idol.io/api/v2/dsp-upload-identifications?page%5Bnumber%5D=1&page%5Bsize%5D=3",
"last": "https://api.idol.io/api/v2/dsp-upload-identifications?page%5Bnumber%5D=1&page%5Bsize%5D=3"
}
}Filter resources
api/v2/dsp-upload-identifications?filter[distributor-id]=1Get DspUploadIdentification
GET https://api.idol.io/api/v2/dsp-upload-identifications/:id
Path Parameters
Name
Type
Description
id*
number
ID of the
Headers
Name
Type
Description
Authorization*
string
Bearer <token>
Content-Type*
string
application/vnd.api+json
{
"data": {
"id": "<ID>",
"type": "dsp-upload-identifications",
"links": {
"self": "https://api.idol.io/api/v2/dsp-upload-identifications/<ID>"
},
"attributes": {
"created-at": "2020-12-13T18:50:17.000+01:00",
"updated-at": "2023-05-30T11:37:19.320+02:00",
"dsp-name": "Apple",
"options": [
{
"name": "custom_vendor_id",
"label": "Custom Vendor ID",
"hint": "If you have trouble uploading/updating an album uploaded via another distributor or the Apple Producer, you can fill this field. You will find it directly on your Apple Producer",
"format": null,
"type": "string",
"value": null
},
{
"name": "preorder_only",
"label": "Number of Last Tracks as Preorder",
"hint": "You can specify up to 50% of the album tracks (or videos) as Instant-Gratification tracks. Purchasers who pre-order the album can download the tracks immediately",
"format": null,
"type": "integer",
"value": null
},
{
"name": "itunes_preorder_price_code_id",
"label": "Price Code During Preorder Period",
"hint": null,
"format": null,
"type": "integer",
"value": [
{
"value": 1,
"name": "P1 - 0,99€"
},
{
"value": 2,
"name": "P2 - 1,99€"
},
{
"value": 3,
"name": "P3 - 2,99€"
},
{
"value": 4,
"name": "P4 - 3,99€"
},
{
"value": 5,
"name": "P5 - 4,99€"
},
{
"value": 6,
"name": "P6 - 5,99€"
},
{
"value": 7,
"name": "P7 - 6,99€"
},
{
"value": 8,
"name": "P8 - 7,99€"
},
{
"value": 9,
"name": "P9 - 8,99€"
},
{
"value": 10,
"name": "P0 - 9,99€"
}
]
},
"relationships": {
"offers": {
"links": {
"self": "https://api.idol.io/api/v2/dsp-upload-identifications/<ID>/relationships/offers",
"related": "https://api.idol.io/api/v2/dsp-upload-identifications/<ID>/offers"
}
},
"dsp": {
"links": {
"self": "https://api.idol.io/api/v2/dsp-upload-identifications/<ID>/relationships/dsp",
"related": "https://api.idol.io/api/v2/dsp-upload-identifications/<ID>/dsp"
},
"data": {
"type": "dsps",
"id": "<ID>"
}
}
}
}
}Get DspUploadIdentification Options
GET https://api.idol.io/api/v2/dsp-upload-identifications/:id
Path Parameters
Name
Type
Description
id*
number
ID of the DspUploadIdentification
Headers
Name
Type
Description
Authorization*
string
Bearer <token>
Content-Type*
string
application/vnd.api+json
{
"data": {
"id": "100",
"type": "dsp-upload-identifications",
"links": {
"self": "http://api.idol.io/api/v2/dsp-upload-identifications/100"
},
"attributes": {
"created-at": "2021-10-29T10:08:43.635+01:00",
"updated-at": "2021-10-29T10:08:43.635+01:00",
"dsp-name": "Apple",
"options": [
{
"name": "custom_vendor_id",
"label": "Custom Vendor ID",
"hint": "If you have trouble uploading/updating an album uploaded via another distributor or the Apple Producer, you can fill this field. You will find it directly on your Apple Producer",
"format": null,
"type": "string",
"value": null
},
{
"name": "preorder_only",
"label": "Number of Last Tracks as Preorder",
"hint": "You can specify up to 50% of the album tracks (or videos) as Instant-Gratification tracks. Purchasers who pre-order the album can download the tracks immediately",
"format": null,
"type": "integer",
"value": null
},
{
"name": "itunes_preorder_price_code_id",
"label": "Price Code During Preorder Period",
"hint": null,
"format": null,
"type": "integer",
"value": [
{
"value": 1,
"name": "P1 - 0,99€"
},
{
"value": 2,
"name": "P2 - 1,99€"
},
{
"value": 3,
"name": "P3 - 2,99€"
},
{
"value": 4,
"name": "P4 - 3,99€"
},
{
"value": 5,
"name": "P5 - 4,99€"
},
{
"value": 6,
"name": "P6 - 5,99€"
},
{
"value": 7,
"name": "P7 - 6,99€"
},
{
"value": 8,
"name": "P8 - 7,99€"
},
{
"value": 9,
"name": "P9 - 8,99€"
},
{
"value": 10,
"name": "P0 - 9,99€"
},
{
"value": 11,
"name": "P1 - 10,99€"
},
{
"value": 12,
"name": "P2 - 11,99€"
},
{
"value": 13,
"name": "P3 - 12,99€"
},
{
"value": 14,
"name": "P4 - 13,99€"
},
{
"value": 15,
"name": "P5 - 14,99€"
},
{
"value": 16,
"name": "P6 - 15,99€"
},
{
"value": 17,
"name": "P7 - 16,99€"
},
{
"value": 18,
"name": "P8 - 17,99€"
},
{
"value": 19,
"name": "P9 - 18,99€"
},
{
"value": 20,
"name": "P0 - 19,99€"
},
{
"value": 21,
"name": "P1 - 20,99€"
},
{
"value": 22,
"name": "P2 - 21,99€"
},
{
"value": 23,
"name": "P3 - 22,99€"
},
{
"value": 24,
"name": "P4 - 23,99€"
},
{
"value": 25,
"name": "P5 - 24,99€"
},
{
"value": 26,
"name": "P6 - 25,99€"
},
{
"value": 27,
"name": "P7 - 26,99€"
},
{
"value": 28,
"name": "P8 - 27,99€"
},
{
"value": 29,
"name": "P9 - 28,99€"
},
{
"value": 30,
"name": "P0 - 29,99€"
},
{
"value": 31,
"name": "P1 - 30,99€"
},
{
"value": 32,
"name": "P2 - 31,99€"
},
{
"value": 33,
"name": "P3 - 32,99€"
},
{
"value": 34,
"name": "P4 - 33,99€"
},
{
"value": 35,
"name": "P5 - 34,99€"
},
{
"value": 36,
"name": "P6 - 35,99€"
},
{
"value": 37,
"name": "P7 - 36,99€"
}
]
}
]
},
"relationships": {
"offers": {
"links": {
"self": "http://api.idol.io/api/v2/dsp-upload-identifications/100/relationships/offers",
"related": "http://api.idol.io/api/v2/dsp-upload-identifications/100/offers"
}
},
"dsp": {
"links": {
"self": "http://api.idol.io/api/v2/dsp-upload-identifications/100/relationships/dsp",
"related": "http://api.idol.io/api/v2/dsp-upload-identifications/100/dsp"
},
"data": {
"type": "dsps",
"id": "3"
}
}
}
}
}Output
options (array)
name : name of the attribute in offer’s resource
label : label for the attribute
hint : details of the attribute (optional)
format : format of the attribute (optional)
type : type of the attribute (string - boolean - integer - float)
value : values expected for this attribute (optional)
Get DspUploadIdentification Track Options
GET https://api.idol.io/api/v2/dsp-upload-identifications/:id
Path Parameters
Name
Type
Description
id*
number
ID of the DspUploadIdentification
Headers
Name
Type
Description
Authorization*
string
Bearer <token>
Content-Type*
string
application/vnd.api+json
{
"data": {
"id": "<ID>",
"type": "dsp-upload-identifications",
"links": {
"self": "http://api.idol.io/api/v2/dsp-upload-identifications/<ID>"
},
"attributes": {
"created-at": "2023-10-29T10:08:43.635+01:00",
"updated-at": "2023-10-29T10:08:43.635+01:00",
"dsp-name": "Amazon",
"track-options": [
{
"name":"release_time",
"label":"Release Time",
"hint":"In UTC time, the album will be released simultaneously in each territory, at the chosen UTC time. Otherwise, the album will be released at the chosen local time in each timezone.",
"format":"/\\d2:\\d2:\\d2/",
"type":"time",
"value":null
},
{
"name":"release_time_global",
"label":"UTC time",
"hint":null,
"format":null,
"type":"boolean",
"value":null
},
{
"name":"amazon_ppd",
"label":"Custom PPD",
"hint":"You can indicate a desired PPD in EUR to use the CUSTOM Amazon price code",
"format":null,
"type":"string",
"value":null
}
],
},
"relationships": {
"offers": {
"links": {
"self": "http://api.idol.io/api/v2/dsp-upload-identifications/<ID>/relationships/offers",
"related": "http://api.idol.io/api/v2/dsp-upload-identifications/<ID>/offers"
}
},
"dsp": {
"links": {
"self": "http://api.idol.io/api/v2/dsp-upload-identifications/<ID>/relationships/dsp",
"related": "http://api.idol.io/api/v2/dsp-upload-identifications/<ID>/dsp"
},
"data": {
"type": "dsps",
"id": "<ID>"
}
}
}
}
}Output
track-options (array)
name : name of the attribute in track offer’s resource
label : label for the attribute
hint : details of the attribute (optional)
format : format of the attribute (optional)
type : type of the attribute (string - boolean - integer - float)
value : values expected for this attribute (optional)
Last updated