Dashgo API

Base URL: /api/v2, Version: 2.0.0

Default response content-types: application/json

Schemes: https

Summary

Path	Operation	Description
/api/v2/albums/	GET	Get all albums
/api/v2/albums/	POST	Create new album
/api/v2/albums/{album_id}	GET	Get single album by id
/api/v2/albums/{album_id}	PUT	Update album by id
/api/v2/albums/{album_id}/artists	DELETE	Delete Artist from Album
	GET	Get Album Artists List
	POST	Add Artist to Album
/api/v2/albums/{album_id}/dsp_territories	DELETE	Delete album DSP territories
	GET	Get album DSP territories
	POST	Add album DSP territories
	PUT	Update album DSP territories
/api/v2/albums/{album_id}/title_localizations	DELETE	Delete album title localization
	GET	Get album title localizations
	POST	Add album title localization
/api/v2/apple_analytics	GET	Return sales analytics Apple API documentation
/api/v2/apple_analytics	POST	Return sales analytics by tracks using Apple API directly
/api/v2/apple_analytics/tracks	POST	Return Apple IDs for DashGo tracks
/api/v2/artists/	GET	Get all artists
/api/v2/artists/	POST	Create new artist
/api/v2/artists/{artist_id}	DELETE	Delete artist
	GET	Get single artist by id
	PUT	Update artist
/api/v2/artists/{artist_id}/name_localizations	DELETE	Delete artist name localization
	GET	Get artist name localizations
	POST	Add artist name localization
/api/v2/beatport_genres/	GET	Get all Beatport genres
/api/v2/distribute/albums	DELETE	Takedown albums
	GET	Distribution status
	POST	Publish albums
/api/v2/distribute/albums/cancel	POST	Cancel pending distribution
/api/v2/distribute/itunes/status	GET	Get Itunes response for distributed album
/api/v2/dsps/	GET	Get all DSPs
/api/v2/genres/	GET	Get all genres
/api/v2/sales_trends	GET	Sales trends
/api/v2/sales_trends/saves	GET	Saved tracks analytics
/api/v2/sales_trends/skips	GET	Skipped tracks analytics
/api/v2/smart_url	GET	Generate and return SmartURL link
/api/v2/smart_url/analytics	GET	Generate and return analytics page link for SmartURL
/api/v2/statements/download	GET	Get statements download link by month
/api/v2/tracks/	GET	Get all tracks
/api/v2/tracks/	POST	Create new track
/api/v2/tracks/{track_id}	DELETE	Delete single track by id
	GET	Get single track by id
	PUT	Update track by id
/api/v2/tracks/{track_id}/artists	DELETE	Delete Artist from Track
	GET	Get Track Artists List
	POST	Add Artist to Track
/api/v2/tracks/{track_id}/previews	GET	Get track previews
/api/v2/tracks/{track_id}/previews	POST	Add track preview
/api/v2/tracks/{track_id}/previews/{preview_id}	DELETE	Delete track preview
/api/v2/tracks/{track_id}/previews/{preview_id}	GET	Get track preview
/api/v2/tracks/{track_id}/title_localizations	DELETE	Delete track title localization
	GET	Get track title localizations
	POST	Add track title localization
/api/v2/trends/downloads	GET	Returns downloads report download URL
/api/v2/trends/playlist_streams	GET	Returns playlist streams report download URL
/api/v2/trends/saves	GET	Returns saves report download URL
/api/v2/trends/skips	GET	Returns skips report download URL
/api/v2/trends/streams	GET	Returns streams report download URL

Paths

Get all albums

GET /api/v2/albums/

Returns list of albums.


page	pagination	path	int
search	search album by name	path	string
upc	search album by UPC	path	string

Uses default content-types: application/json

200 OK: List all albums

GetAllResponse
403 Forbidden: Authorization required

Create new album

POST /api/v2/albums/

Create new album.


c_line	formData	string (YYYY Copyright)
label_name	formData	string
p_line	formData	string (YYYY Copyright)
release_date	formData	date (YYYY-mm-dd)
sale_start_date	formData	date (YYYY-mm-dd)
title	formData	string
genre	formData	string , x ∈ { genres }
album_genres	formData	string ([{"genre":"dance_elec"},{"genre":"rap"}, ...]) , x ∈ { genres }
album_territories	formData	string ([{"territory":"UK"},{"territory":"US"},...]) , x ∈ { territories }
beatport_genre	formData	string , x ∈ { beatport_genres }
cover	formData	file
exclude_territories	formData	string ([{"territory":"UK"},{"territory":"US"},...]) , x ∈ { territories }
language	formData	string , x ∈ { Afrikaans , Arabic , Bulgarian , Cantonese , Catalan , Chinese , Croatian , Czech , Danish , Dutch , English , Estonian , Finnish , French , German , Greek , Hebrew , Hindi , Hungarian , Icelandic , Indonesian , Italian , Japanese , Kazakh , Korean , Lao , Latvian , Lithuanian , Malay , None , Norwegian , Polish , Portuguese , Romanian , Russian , Slovak , Slovenian , Spanish , Swedish , Tagalog , Tamil , Telugu , Thai , Turkish , Ukrainian , Urdu , Vietnamese , Zulu }
preorder_release_date	formData	date (YYYY-mm-dd)
price	formData	float , x ∈ { 9.99 , 8.99 , 7.99 , 6.99 , 5.99 , 4.99 , 3.99 , 2.99 , 1.99 }
secondary_language	formData	string
track_price	formData	float , x ∈ { 1.29 , 0.99 , 0.69 }
upc	formData	string (numeric string 10..13 chars [will be generated if not provided])
various_artists	formData	boolean

Uses default content-types: application/json

201 Created: create new album

Album
400 Bad Request: Bad request. Validation error.
403 Forbidden: Authorization required

Get single album by id

GET /api/v2/albums/{album_id}

Returns single album.

Uses default content-types: application/json

200 OK: Get single album by id

Album
403 Forbidden: Authorization required
404 Not Found: Item not found.

Update album by id

PUT /api/v2/albums/{album_id}

Update album data by id.


id	album ID	path	string
c_line		formData	string (YYYY Copyright)
cover		formData	file
label_name		formData	string
p_line		formData	string (YYYY Copyright)
release_date		formData	date (YYYY-mm-dd)
sale_start_date		formData	date (YYYY-mm-dd)
title		formData	string
album_genres		formData	string ([{"genre":"dance_elec"},{"genre":"rap"}, ...]) , x ∈ { genres }
album_territories		formData	string ([{"territory":"UK"},{"territory":"US"},...]) , x ∈ { territories }
beatport_genre		formData	string , x ∈ { beatport_genres }
exclude_territories		formData	string ([{"territory":"UK"},{"territory":"US"},...]) , x ∈ { territories }
genre		formData	string , x ∈ { genres }
language		formData	string , x ∈ { Afrikaans , Arabic , Bulgarian , Cantonese , Catalan , Chinese , Croatian , Czech , Danish , Dutch , English , Estonian , Finnish , French , German , Greek , Hebrew , Hindi , Hungarian , Icelandic , Indonesian , Italian , Japanese , Kazakh , Korean , Lao , Latvian , Lithuanian , Malay , None , Norwegian , Polish , Portuguese , Romanian , Russian , Slovak , Slovenian , Spanish , Swedish , Tagalog , Tamil , Telugu , Thai , Turkish , Ukrainian , Urdu , Vietnamese , Zulu }
preorder_release_date		formData	date (YYYY-mm-dd)
price		formData	float , x ∈ { 9.99 , 8.99 , 7.99 , 6.99 , 5.99 , 4.99 , 3.99 , 2.99 , 1.99 }
secondary_language		formData	string
track_price		formData	float , x ∈ { 1.29 , 0.99 , 0.69 }
upc		formData	int
various_artists		formData	boolean

Uses default content-types: application/json

200 OK: The updated album data

Album
400 Bad Request: Bad request. Validation error.
403 Forbidden: Authorization required
404 Not Found: Album not found

Delete Artist from Album

DELETE /api/v2/albums/{album_id}/artists

Delete Artist from Album


artist_id		formData	int
role	Allowed roles are: any role from Contributor Roles + ["primary", "featuring"]	formData	string

Uses default content-types: application/json

204 No Content: Artists Successfully Deleted from Album
400 Bad Request: Bad request. Validation error.
401 Unauthorized: Authorization required
403 Forbidden: Access to Album is forbidden
404 Not Found: Album not found

Get Album Artists List

GET /api/v2/albums/{album_id}/artists

Returns list of album artists

Uses default content-types: application/json

200 OK: List all album artists

AlbumArtists
401 Unauthorized: Authorization required
403 Forbidden: Access to Album is forbidden
404 Not Found: Album not found

Add Artist to Album

POST /api/v2/albums/{album_id}/artists

Add Artist to Album


artist_id		formData	int
role	Allowed roles are: any role from Contributor Roles + ["primary", "featuring"]	formData	string

Uses default content-types: application/json

201 Created: Artists Successfully Added to Album
400 Bad Request: Bad request. Validation error.
401 Unauthorized: Authorization required
403 Forbidden: Access to Album is forbidden
404 Not Found: Album not found
409 Conflict: Artists Already Added to Album

Delete album DSP territories

DELETE /api/v2/albums/{album_id}/dsp_territories

Delete album DSP territories


album_id		path	int
dsp_site		formData	string

Uses default content-types: application/json

200 OK: Album DSP territories deleted
403 Forbidden: Authorization required
404 Not Found: Item not found

Get album DSP territories

GET /api/v2/albums/{album_id}/dsp_territories

Returns list of album DSP territories


album_id		path	int
dsp_site		formData	string

Uses default content-types: application/json

200 OK: List album DSP territories

AlbumDspTerritories
400 Bad Request: Bad request. Validation error.
403 Forbidden: Authorization required
404 Not Found: Item not found

Add album DSP territories

POST /api/v2/albums/{album_id}/dsp_territories

Add DSP territories to album.


album_id	path	int
dsp_site	formData	string
territories	formData	object[] , x ∈ { AF , AX , AL , DZ , AS , AD , AO , AI , AQ , AG , AR , AM , AW , AU , AT , AZ , BS , BH , BD , BB , BY , BE , BZ , BJ , BM , BT , BO , BA , BW , BV , BR , VG , IO , BN , BG , BF , BI , KH , CM , CA , CV , KY , CF , TD , CL , CN , HK , MO , CX , CC , CO , KM , CG , CD , CK , CR , CI , HR , CU , CY , CZ , DK , DJ , DM , DO , EC , EG , SV , GQ , ER , EE , ET , FK , FO , FJ , FI , FR , GF , PF , TF , GA , GM , GE , DE , GH , GI , GR , GL , GD , GP , GU , GT , GG , GN , GW , GY , HT , HM , VA , HN , HU , IS , IN , ID , IR , IQ , IE , IM , IL , IT , JM , JP , JE , JO , KZ , KE , KI , KP , KR , KW , KG , LA , LV , LB , LS , LR , LY , LI , LT , LU , MK , MG , MW , MY , MV , ML , MT , MH , MQ , MR , MU , YT , MX , FM , MD , MC , MN , ME , MS , MA , MZ , MM , NA , NR , NP , NL , AN , NC , NZ , NI , NE , NG , NU , NF , MP , NO , OM , PK , PW , PS , PA , PG , PY , PE , PH , PN , PL , PT , PR , QA , RE , RO , RU , RW , BL , SH , KN , LC , MF , PM , VC , WS , SM , ST , SA , SN , RS , SC , SL , SG , SK , SI , SB , SO , ZA , GS , SS , ES , LK , SD , SR , SJ , SZ , SE , CH , SY , TW , TJ , TZ , TH , TL , TG , TK , TO , TT , TN , TR , TM , TC , TV , UG , UA , AE , GB , US , UM , UY , UZ , VU , VE , VN , VI , WF , EH , YE , ZM , ZW , WO }
is_excluded	formData	boolean

Uses default content-types: application/json

200 OK: Create album DSP territories

AlbumDspTerritories
400 Bad Request: Bad request. Validation error.
403 Forbidden: Authorization required
404 Not Found: Item not found
409 Conflict: Album territories already exist for this DSP

Update album DSP territories

PUT /api/v2/albums/{album_id}/dsp_territories

Update album DSP territories


album_id	path	int
dsp_site	formData	string
territories	formData	object[] , x ∈ { AF , AX , AL , DZ , AS , AD , AO , AI , AQ , AG , AR , AM , AW , AU , AT , AZ , BS , BH , BD , BB , BY , BE , BZ , BJ , BM , BT , BO , BA , BW , BV , BR , VG , IO , BN , BG , BF , BI , KH , CM , CA , CV , KY , CF , TD , CL , CN , HK , MO , CX , CC , CO , KM , CG , CD , CK , CR , CI , HR , CU , CY , CZ , DK , DJ , DM , DO , EC , EG , SV , GQ , ER , EE , ET , FK , FO , FJ , FI , FR , GF , PF , TF , GA , GM , GE , DE , GH , GI , GR , GL , GD , GP , GU , GT , GG , GN , GW , GY , HT , HM , VA , HN , HU , IS , IN , ID , IR , IQ , IE , IM , IL , IT , JM , JP , JE , JO , KZ , KE , KI , KP , KR , KW , KG , LA , LV , LB , LS , LR , LY , LI , LT , LU , MK , MG , MW , MY , MV , ML , MT , MH , MQ , MR , MU , YT , MX , FM , MD , MC , MN , ME , MS , MA , MZ , MM , NA , NR , NP , NL , AN , NC , NZ , NI , NE , NG , NU , NF , MP , NO , OM , PK , PW , PS , PA , PG , PY , PE , PH , PN , PL , PT , PR , QA , RE , RO , RU , RW , BL , SH , KN , LC , MF , PM , VC , WS , SM , ST , SA , SN , RS , SC , SL , SG , SK , SI , SB , SO , ZA , GS , SS , ES , LK , SD , SR , SJ , SZ , SE , CH , SY , TW , TJ , TZ , TH , TL , TG , TK , TO , TT , TN , TR , TM , TC , TV , UG , UA , AE , GB , US , UM , UY , UZ , VU , VE , VN , VI , WF , EH , YE , ZM , ZW , WO }
is_excluded	formData	boolean

Uses default content-types: application/json

200 OK: Update album DSP territories

AlbumDspTerritories
400 Bad Request: Bad request. Validation error.
403 Forbidden: Authorization required
404 Not Found: Item not found

Delete album title localization

DELETE /api/v2/albums/{album_id}/title_localizations

Delete album title localization


title_localization		formData	string
title_localization_language		formData	string , x ∈ { Afrikaans , Arabic , Bengali , Bulgarian , Cantonese , Catalan , Chinese (Simplified) , Chinese (Traditional) , Croatian , Czech , Danish , Dutch , English , Estonian , Finnish , French , German , Greek , Haitian , Hebrew , Hindi , Hungarian , Icelandic , Indonesian , Irish , Italian , Japanese , Kazakh , Korean , Lao , Latin , Latvian , Lithuanian , Malay , Norwegian , Persian , Polish , Portuguese , Punjabi , Romanian , Russian , Sanskrit , Slovak , Slovenian , Spanish , Spanish (Latin America)* , Swedish , Tagalog , Tamil , Telugu , Thai , Turkish , Ukrainian , Urdu , Vietnamese , Zulu }

Uses default content-types: application/json

204 No Content: Title Localization Successfully Deleted from Album
400 Bad Request: Bad request. Validation error.
401 Unauthorized: Authorization required
403 Forbidden: Access to Album is forbidden
404 Not Found: Album not found

Get album title localizations

GET /api/v2/albums/{album_id}/title_localizations

Returns list of album title localizations

Uses default content-types: application/json

200 OK: List all album title localizations

AlbumTitleLocalizations
400 Bad Request: Bad request. Validation error.
401 Unauthorized: Authorization required
403 Forbidden: Access to Album is forbidden
404 Not Found: Album not found

Add album title localization

POST /api/v2/albums/{album_id}/title_localizations

Add album title localization


title_localization		formData	string
title_localization_language		formData	string , x ∈ { Afrikaans , Arabic , Bengali , Bulgarian , Cantonese , Catalan , Chinese (Simplified) , Chinese (Traditional) , Croatian , Czech , Danish , Dutch , English , Estonian , Finnish , French , German , Greek , Haitian , Hebrew , Hindi , Hungarian , Icelandic , Indonesian , Irish , Italian , Japanese , Kazakh , Korean , Lao , Latin , Latvian , Lithuanian , Malay , Norwegian , Persian , Polish , Portuguese , Punjabi , Romanian , Russian , Sanskrit , Slovak , Slovenian , Spanish , Spanish (Latin America)* , Swedish , Tagalog , Tamil , Telugu , Thai , Turkish , Ukrainian , Urdu , Vietnamese , Zulu }

Uses default content-types: application/json

201 Created: Title Localization Successfully Added to Album
400 Bad Request: Bad request. Validation error.
401 Unauthorized: Authorization required
403 Forbidden: Access to Album is forbidden
404 Not Found: Album not found
409 Conflict: Title Localization Already Added to Album

Return sales analytics Apple API documentation

GET /api/v2/apple_analytics

Return sales analytics Apple API documentation

Return sales analytics by tracks using Apple API directly

POST /api/v2/apple_analytics

Return sales analytics by tracks using Apple API directly

Return Apple IDs for DashGo tracks

POST /api/v2/apple_analytics/tracks

Return Apple IDs for DashGo tracks


track_id_list	List of track ID	formData	Array

Uses default content-types: application/json

200 OK: Tracks data

AppleTrack
400 Bad Request: Bad request. Validation error.
401 Unauthorized: Authorization required

Get all artists

GET /api/v2/artists/

Returns list of artists.


page	pagination	path	int
search	search artist by name	path	string

Uses default content-types: application/json

200 OK: List all artists

GetAllResponse
403 Forbidden: Authorization required

Create new artist

POST /api/v2/artists/

Create new artist.


name		formData	string
amazon_asin		formData	string
apple_id		formData	string
bio		formData	string
isni		formData	string
spotify_uri		formData	string
new_apple_artist	If not added in formData will be "false" by default	formData	boolean
new_spotify_artist	If not added in formData will be "false" by default	formData	boolean

Uses default content-types: application/json

200 OK: Artist created

Artist
400 Bad Request: Bad request. Validation error.
401 Unauthorized: Authorization required

Delete artist

DELETE /api/v2/artists/{artist_id}

Delete artist


id		path	int

Uses default content-types: application/json

200 OK: Artist deleted
400 Bad Request: Artist can't be removed as it still associated with one or more albums
401 Unauthorized: Authorization required

Get single artist by id

GET /api/v2/artists/{artist_id}

Returns single artist.

Uses default content-types: application/json

200 OK: Get single artist by id

Artist
401 Unauthorized: Authorization required
404 Not Found: Artist not found

Update artist

PUT /api/v2/artists/{artist_id}

Update artist


name	formData	string
amazon_asin	formData	string
apple_id	formData	string
bio	formData	string
isni	formData	string
spotify_uri	formData	string

Uses default content-types: application/json

200 OK: Artist updated

Artist
400 Bad Request: Bad request. Validation error.
401 Unauthorized: Authorization required

Delete artist name localization

DELETE /api/v2/artists/{artist_id}/name_localizations

Delete artist name localization


name_localization		formData	string
name_localization_language		formData	string , x ∈ { Afrikaans , Arabic , Bengali , Bulgarian , Cantonese , Catalan , Chinese (Simplified) , Chinese (Traditional) , Croatian , Czech , Danish , Dutch , English , Estonian , Finnish , French , German , Greek , Haitian , Hebrew , Hindi , Hungarian , Icelandic , Indonesian , Irish , Italian , Japanese , Kazakh , Korean , Lao , Latin , Latvian , Lithuanian , Malay , Norwegian , Persian , Polish , Portuguese , Punjabi , Romanian , Russian , Sanskrit , Slovak , Slovenian , Spanish , Spanish (Latin America)* , Swedish , Tagalog , Tamil , Telugu , Thai , Turkish , Ukrainian , Urdu , Vietnamese , Zulu }

Uses default content-types: application/json

204 No Content: Name Localization Successfully Deleted from Artist
400 Bad Request: Bad request. Validation error.
401 Unauthorized: Authorization required
404 Not Found: Artist not found

Get artist name localizations

GET /api/v2/artists/{artist_id}/name_localizations

Returns list of artist name localizations

Uses default content-types: application/json

200 OK: List all artist name localizations

ArtistNameLocalizations
400 Bad Request: Bad request. Validation error.
401 Unauthorized: Authorization required
404 Not Found: Artist not found

Add artist name localization

POST /api/v2/artists/{artist_id}/name_localizations

Add artist name localization


name_localization		formData	string
name_localization_language		formData	string , x ∈ { Afrikaans , Arabic , Bengali , Bulgarian , Cantonese , Catalan , Chinese (Simplified) , Chinese (Traditional) , Croatian , Czech , Danish , Dutch , English , Estonian , Finnish , French , German , Greek , Haitian , Hebrew , Hindi , Hungarian , Icelandic , Indonesian , Irish , Italian , Japanese , Kazakh , Korean , Lao , Latin , Latvian , Lithuanian , Malay , Norwegian , Persian , Polish , Portuguese , Punjabi , Romanian , Russian , Sanskrit , Slovak , Slovenian , Spanish , Spanish (Latin America)* , Swedish , Tagalog , Tamil , Telugu , Thai , Turkish , Ukrainian , Urdu , Vietnamese , Zulu }

Uses default content-types: application/json

201 Created: Name Localization Successfully Added to Artist
400 Bad Request: Bad request. Validation error.
401 Unauthorized: Authorization required
404 Not Found: Artist not found
409 Conflict: Name Localization Already Added to Artist

Get all Beatport genres

GET /api/v2/beatport_genres/

Returns list of Beatport genres for use in distribution methods.

Uses default content-types: application/json

200 OK: List all genres

BeatportGenresList
403 Forbidden: Authorization required

Takedown albums

DELETE /api/v2/distribute/albums

Takedown albums.


album_ids	JSON array of albums IDs	formData	JSON
dsp	JSON array of DSPs	formData	JSON

Uses default content-types: application/json

200 OK: Takedown albums

Distribution
400 Bad Request: Bad Request
403 Forbidden: Authorization required

Distribution status

GET /api/v2/distribute/albums

Distribution status.


album_id	album ID	path	int
dsp_site	name of dsp	path	string

Uses default content-types: application/json

200 OK: Distribution statuses list

DistributionStatuses
403 Forbidden: Authorization required
404 Not Found: Item not found.

Publish albums

POST /api/v2/distribute/albums

Publish albums.


album_ids	JSON array of albums IDs	formData	JSON
dsp	JSON array of DSPs	formData	JSON

Uses default content-types: application/json

200 OK: Published albums

Distribution
400 Bad Request: Bad request. Validation error.
403 Forbidden: Authorization required

Cancel pending distribution

POST /api/v2/distribute/albums/cancel

Cancel pending distribution


album_id	album ID	path	int
dsp_site	name of dsp	path	string

Uses default content-types: application/json

201 Created: Distribution was canceled successfully

DistributionCancelResponse
400 Bad Request: Bad Request
401 Unauthorized: Authorization required
403 Forbidden: Distribution can not be canceled

DistributionCancelResponse
404 Not Found: Item not found

Get Itunes response for distributed album

GET /api/v2/distribute/itunes/status

Itunes response for distributed album.


album_id	album ID	path	int

Uses default content-types: application/json

200 OK: Itunes response

ItunesStatus
400 Bad Request: Bad request. Validation error.
403 Forbidden: Authorization required

Get all DSPs

GET /api/v2/dsps/

Returns list of DSPs for use in distribution methods.

Uses default content-types: application/json

200 OK: List all DSPs

DspsList
403 Forbidden: Authorization required

Get all genres

GET /api/v2/genres/

Returns list of genres for use in distribution methods.

Uses default content-types: application/json

200 OK: List all genres

GenresList
403 Forbidden: Authorization required

Sales trends

GET /api/v2/sales_trends

Return sales trends by LABEL/ARTIST/ALBUM/TRACK.


date_from	Starting date YYYY-mm-dd	formData	int
date_to	Ending date YYYY-mm-dd	formData	string
dsp	dsp	formData	string , x ∈ { itunes , spotify , applemusic , amazon , amazonmusic , soundcloud , youtube , youtubemusic , deezer , pandora , tiktok }
unit_id	ID of unit (in case Unit type 'track' accept 50 ids comma separated)	formData	string
unit_type	Unit type	formData	string , x ∈ { artist , album , track }

Uses default content-types: application/json

200 OK: List sales trends

SalesTrends
400 Bad Request: Maximum 50 unit id
403 Forbidden: Authorization required

Saved tracks analytics

GET /api/v2/sales_trends/saves

Returns analytics for saved tracks for LABEL/ARTIST/ALBUM/TRACK


date_from	Starting date YYYY-mm-dd	formData	int
date_to	Ending date YYYY-mm-dd	formData	string
dsp	dsp	formData	string , x ∈ { spotify , applemusic }
unit_id	ID of unit	formData	string
unit_type	Unit type	formData	string , x ∈ { artist , album , track }

Uses default content-types: application/json

200 OK: List analytics data for saved tracks

SalesTrends
401 Unauthorized: Authorization required
403 Forbidden: Access forbidden

Skipped tracks analytics

GET /api/v2/sales_trends/skips

Returns analytics for skipped tracks for LABEL/ARTIST/ALBUM/TRACK


date_from	Starting date YYYY-mm-dd	formData	int
date_to	Ending date YYYY-mm-dd	formData	string
dsp	dsp	formData	string , x ∈ { spotify , applemusic }
unit_id	ID of unit	formData	string
unit_type	Unit type	formData	string , x ∈ { artist , album , track }

Uses default content-types: application/json

200 OK: List analytics data for skipped tracks

SalesTrends
401 Unauthorized: Authorization required
403 Forbidden: Access forbidden

Generate and return SmartURL link

GET /api/v2/smart_url

Generate and return SmartURL link


album_id	Album ID	formData	int
regenerate	force regenerate link	formData	boolean

Uses default content-types: application/json

200 OK: Show result of generating SmartURL link

SmartURL
400 Bad Request: Bad request. Validation error.
401 Unauthorized: Authorization required
403 Forbidden: Access to album is forbidden
404 Not Found: Album not found

Generate and return analytics page link for SmartURL

GET /api/v2/smart_url/analytics

Generate and return analytics page link for SmartURL


album_id	Album ID	formData	int

Uses default content-types: application/json

200 OK: Show result of generating analytics page link

SmartURL
400 Bad Request: Bad request. Validation error.
401 Unauthorized: Authorization required
403 Forbidden: Access to album is forbidden
404 Not Found: Album not found

Get statements download link by month

GET /api/v2/statements/download

Return statements download link by month


month	month	formData	int , x ∈ { 1 , 2 , 3 , 4 , 5 , 6 , 7 , 8 , 9 , 10 , 11 , 12 }
year	year	formData	int , x ∈ { 2015 , 2016 , ... }

Uses default content-types: application/json

200 OK: Show download link

StatementsDownload
400 Bad Request: Bad request. Validation error.
403 Forbidden: Authorization required
404 Not Found: Report not found

Get all tracks

GET /api/v2/tracks/

Returns list of tracks.


album_id	filter tracks by album ID	path	string
upc	filter tracks by album UPC	path	string
isrc	filter tracks by ISRC	path	string (US-NNN-YY-DDDDD)
page	pagination	path	int

Uses default content-types: application/json

200 OK: List all tracks

GetAllResponse
403 Forbidden: Authorization required

Create new track

POST /api/v2/tracks/

Create new track.


album_id	formData	int
disc_number	formData	int
explicit	formData	int , x ∈ { 0 , 1 }
position	formData	int
title	formData	string
track	formData	file (FLAC, WAV)
track_spatial_file	formData	file
c_line	formData	string (YYYY Copyright)
p_line	formData	string (YYYY Copyright)
isrc	formData	string (US-NNN-YY-DDDDD [will be generated if not provided])
label_track_id	formData	string
lyrics	formData	string
price	formData	float , x ∈ { 1.29 , 0.99 , 0.69 }
track_language	formData	string , x ∈ { Afrikaans , Arabic , Bulgarian , Cantonese , Catalan , Chinese , Croatian , Czech , Danish , Dutch , English , Estonian , Finnish , French , German , Greek , Hebrew , Hindi , Hungarian , Icelandic , Indonesian , Italian , Japanese , Kazakh , Korean , Lao , Latvian , Lithuanian , Malay , None , Norwegian , Polish , Portuguese , Romanian , Russian , Slovak , Slovenian , Spanish , Swedish , Tagalog , Tamil , Telugu , Thai , Turkish , Ukrainian , Urdu , Vietnamese , Zulu }
version	formData	string
instant_grat_release_date	formData	date (YYYY-mm-dd)

Uses default content-types: application/json

200 OK: create new track

Track
400 Bad Request: Bad request. Validation error.
403 Forbidden: Authorization required

Delete single track by id

DELETE /api/v2/tracks/{track_id}

Delete single track.


id		path	int

Uses default content-types: application/json

204 No Content: Deleted single track by id
401 Unauthorized: Authorization required
403 Forbidden: Access to Track is forbidden
404 Not Found: Item not found.
409 Conflict: Conflict.

Get single track by id

GET /api/v2/tracks/{track_id}

Returns single track.

Uses default content-types: application/json

200 OK: Get single track by id

Track
403 Forbidden: Authorization required
404 Not Found: Item not found.

Update track by id

PUT /api/v2/tracks/{track_id}

Update track data by id.


id	track ID	path	string
disc_number		formData	int
explicit		formData	int , x ∈ { 0 , 1 }
position		formData	int
title		formData	string
track		formData	file (FLAC, WAV)
track_spatial_file		formData	file
c_line		formData	string (YYYY Copyright)
p_line		formData	string (YYYY Copyright)
isrc		formData	string (US-NNN-YY-DDDDD)
label_track_id		formData	string
lyrics		formData	string
price		formData	float , x ∈ { 1.29 , 0.99 , 0.69 }
track_language		formData	string , x ∈ { Afrikaans , Arabic , Bulgarian , Cantonese , Catalan , Chinese , Croatian , Czech , Danish , Dutch , English , Estonian , Finnish , French , German , Greek , Hebrew , Hindi , Hungarian , Icelandic , Indonesian , Italian , Japanese , Kazakh , Korean , Lao , Latvian , Lithuanian , Malay , None , Norwegian , Polish , Portuguese , Romanian , Russian , Slovak , Slovenian , Spanish , Swedish , Tagalog , Tamil , Telugu , Thai , Turkish , Ukrainian , Urdu , Vietnamese , Zulu }
version		formData	string
instant_grat_release_date		formData	date (YYYY-mm-dd)

Uses default content-types: application/json

200 OK: The updated track data

Track
400 Bad Request: Bad request. Validation error.
403 Forbidden: Authorization required
404 Not Found: Item not found.

Delete Artist from Track

DELETE /api/v2/tracks/{track_id}/artists

Delete Artist from Track


artist_id		formData	int
role	Allowed roles are: any role from Contributor Roles + ["primary", "featuring"]	formData	string

Uses default content-types: application/json

204 No Content: Artists Successfully Deleted from Track
400 Bad Request: Bad request. Validation error.
401 Unauthorized: Authorization required
403 Forbidden: Access to Album is forbidden
404 Not Found: Track not found

Get Track Artists List

GET /api/v2/tracks/{track_id}/artists

Returns list of track artists

Uses default content-types: application/json

200 OK: List all track artists

TrackArtists
401 Unauthorized: Authorization required
403 Forbidden: Access to Album is forbidden
404 Not Found: Track not found

Add Artist to Track

POST /api/v2/tracks/{track_id}/artists

Add Artist to Track


artist_id		formData	int
role	Allowed roles are: any role from Contributor Roles + ["primary", "featuring"]	formData	string

Uses default content-types: application/json

201 Created: Artists Successfully Added to Track
400 Bad Request: Bad request. Validation error.
401 Unauthorized: Authorization required
403 Forbidden: Access to Album is forbidden
404 Not Found: Track not found
409 Conflict: Artists Already Added to Track

Get track previews

GET /api/v2/tracks/{track_id}/previews

Returns list of track previews

Uses default content-types: application/json

200 OK: List all track previews

TrackPreviews
400 Bad Request: Bad request. Validation error.
401 Unauthorized: Authorization required
403 Forbidden: Access to Track is forbidden
404 Not Found: Track not found

Add track preview

POST /api/v2/tracks/{track_id}/previews

Add track preview


duration	For iTunes duration is always 30.	formData	integer
start_time		formData	integer
start_date	Only supported by Youtube.	formData	date (YYYY-mm-dd)
dsp_site		formData	string , x ∈ { itunes , tiktok , youtube }

Uses default content-types: application/json

200 OK: Preview Successfully Added to Track

TrackPreview
400 Bad Request: Bad request. Validation error.
401 Unauthorized: Authorization required
403 Forbidden: Access to Track is forbidden
404 Not Found: Track not found

Delete track preview

DELETE /api/v2/tracks/{track_id}/previews/{preview_id}

Delete track preview


preview_id		formData	integer

Uses default content-types: application/json

204 No Content: Preview Successfully Deleted from Track
400 Bad Request: Bad request. Validation error.
401 Unauthorized: Authorization required
403 Forbidden: Access to Track is forbidden
404 Not Found: Track not found

Get track preview

GET /api/v2/tracks/{track_id}/previews/{preview_id}

Returns track preview

Uses default content-types: application/json

200 OK: Track preview

TrackPreview
400 Bad Request: Bad request. Validation error.
401 Unauthorized: Authorization required
403 Forbidden: Access to Track is forbidden
404 Not Found: Track not found

Delete track title localization

DELETE /api/v2/tracks/{track_id}/title_localizations

Delete track title localization


title_localization		formData	string
title_localization_language		formData	string , x ∈ { Afrikaans , Arabic , Bengali , Bulgarian , Cantonese , Catalan , Chinese (Simplified) , Chinese (Traditional) , Croatian , Czech , Danish , Dutch , English , Estonian , Finnish , French , German , Greek , Haitian , Hebrew , Hindi , Hungarian , Icelandic , Indonesian , Irish , Italian , Japanese , Kazakh , Korean , Lao , Latin , Latvian , Lithuanian , Malay , Norwegian , Persian , Polish , Portuguese , Punjabi , Romanian , Russian , Sanskrit , Slovak , Slovenian , Spanish , Spanish (Latin America)* , Swedish , Tagalog , Tamil , Telugu , Thai , Turkish , Ukrainian , Urdu , Vietnamese , Zulu }

Uses default content-types: application/json

204 No Content: Title Localization Successfully Deleted from Track
400 Bad Request: Bad request. Validation error.
401 Unauthorized: Authorization required
403 Forbidden: Access to Track is forbidden
404 Not Found: Track not found

Get track title localizations

GET /api/v2/tracks/{track_id}/title_localizations

Returns list of track title localizations

Uses default content-types: application/json

200 OK: List all track title localizations

TrackTitleLocalizations
400 Bad Request: Bad request. Validation error.
401 Unauthorized: Authorization required
403 Forbidden: Access to Track is forbidden
404 Not Found: Track not found

Add track title localization

POST /api/v2/tracks/{track_id}/title_localizations

Add track title localization


title_localization		formData	string
title_localization_language		formData	string , x ∈ { Afrikaans , Arabic , Bengali , Bulgarian , Cantonese , Catalan , Chinese (Simplified) , Chinese (Traditional) , Croatian , Czech , Danish , Dutch , English , Estonian , Finnish , French , German , Greek , Haitian , Hebrew , Hindi , Hungarian , Icelandic , Indonesian , Irish , Italian , Japanese , Kazakh , Korean , Lao , Latin , Latvian , Lithuanian , Malay , Norwegian , Persian , Polish , Portuguese , Punjabi , Romanian , Russian , Sanskrit , Slovak , Slovenian , Spanish , Spanish (Latin America)* , Swedish , Tagalog , Tamil , Telugu , Thai , Turkish , Ukrainian , Urdu , Vietnamese , Zulu }

Uses default content-types: application/json

201 Created: Title Localization Successfully Added to Track
400 Bad Request: Bad request. Validation error.
401 Unauthorized: Authorization required
403 Forbidden: Access to Track is forbidden
404 Not Found: Track not found
409 Conflict: Title Localization Already Added to Track

Returns downloads report download URL

GET /api/v2/trends/downloads

Returns downloads report download URL


dsp_site	DSP	formData	string , x ∈ { amazon , itunes }
report_date	Report Date	formData	date (YYYY-mm-dd)
page	pagination	path	int
perPage	pagination	path	int

Uses default content-types: application/json

200 OK: Returns an array of items

TrendsReport
400 Bad Request: Bad request. Validation error.
401 Unauthorized: Authorization required

Returns playlist streams report download URL

GET /api/v2/trends/playlist_streams

Returns playlist streams report download URL


dsp_site	DSP	formData	string , x ∈ { applemusic , spotify }
report_date	Report Date	formData	date (YYYY-mm-dd)
page	pagination	path	int
perPage	pagination	path	int

Uses default content-types: application/json

200 OK: Returns an array of items

TrendsReport
400 Bad Request: Bad request. Validation error.
401 Unauthorized: Authorization required

Returns saves report download URL

GET /api/v2/trends/saves

Returns saves report download URL


dsp_site	DSP	formData	string , x ∈ { spotify }
report_date	Report Date	formData	date (YYYY-mm-dd)
page	pagination	path	int
perPage	pagination	path	int

Uses default content-types: application/json

200 OK: Returns an array of items

TrendsReport
400 Bad Request: Bad request. Validation error.
401 Unauthorized: Authorization required

Returns skips report download URL

GET /api/v2/trends/skips

Returns skips report download URL


dsp_site	DSP	formData	string , x ∈ { applemusic , spotify }
report_date	Report Date	formData	date (YYYY-mm-dd)
page	pagination	path	int
perPage	pagination	path	int

Uses default content-types: application/json

200 OK: Returns an array of items

TrendsReport
400 Bad Request: Bad request. Validation error.
401 Unauthorized: Authorization required

Returns streams report download URL

GET /api/v2/trends/streams

Returns streams report download URL


dsp_site	DSP	formData	string , x ∈ { amazonmusic , applemusic , deezer , facebookmusic , instagram , pandora , soundcloud , spotify , tiktok , youtube , youtubemusic }
report_date	Report Date	formData	date (YYYY-mm-dd)
page	pagination	path	int
perPage	pagination	path	int

Uses default content-types: application/json

200 OK: Returns an array of items

TrendsReport
400 Bad Request: Bad request. Validation error.
401 Unauthorized: Authorization required

Schema definitions

Album: object

id: int
album_genres: string , x ∈ { genres }: Album secondary genres array.
album_territories: string , x ∈ { territories }: Album territories array.
beatport_genre: string , x ∈ { beatport_genres }
c_line: string (YYYY Copyright): Album c line.
cover: file
genre: string , x ∈ { genres }
label_name: string
language: string , x ∈ { Afrikaans , Arabic , Bulgarian , Cantonese , Catalan , Chinese , Croatian , Czech , Danish , Dutch , English , Estonian , Finnish , French , German , Greek , Hebrew , Hindi , Hungarian , Icelandic , Indonesian , Italian , Japanese , Kazakh , Korean , Lao , Latvian , Lithuanian , Malay , None , Norwegian , Polish , Portuguese , Romanian , Russian , Slovak , Slovenian , Spanish , Swedish , Tagalog , Tamil , Telugu , Thai , Turkish , Ukrainian , Urdu , Vietnamese , Zulu }
p_line: string (YYYY Copyright): Album p line.
preorder_release_date: date
release_date: date: Album release date
sale_start_date: date
secondary_language: string
title: string: Album title.
upc: number
various_artists: boolean

AlbumArtists: object

artists: object[]

object

artist_id: integer
role: string: Allowed roles are: any role from Contributor Roles + ["primary", "featuring"]

AlbumDspTerritories: object

dsp_name: string
territories: object[] , x ∈ { AF , AX , AL , DZ , AS , AD , AO , AI , AQ , AG , AR , AM , AW , AU , AT , AZ , BS , BH , BD , BB , BY , BE , BZ , BJ , BM , BT , BO , BA , BW , BV , BR , VG , IO , BN , BG , BF , BI , KH , CM , CA , CV , KY , CF , TD , CL , CN , HK , MO , CX , CC , CO , KM , CG , CD , CK , CR , CI , HR , CU , CY , CZ , DK , DJ , DM , DO , EC , EG , SV , GQ , ER , EE , ET , FK , FO , FJ , FI , FR , GF , PF , TF , GA , GM , GE , DE , GH , GI , GR , GL , GD , GP , GU , GT , GG , GN , GW , GY , HT , HM , VA , HN , HU , IS , IN , ID , IR , IQ , IE , IM , IL , IT , JM , JP , JE , JO , KZ , KE , KI , KP , KR , KW , KG , LA , LV , LB , LS , LR , LY , LI , LT , LU , MK , MG , MW , MY , MV , ML , MT , MH , MQ , MR , MU , YT , MX , FM , MD , MC , MN , ME , MS , MA , MZ , MM , NA , NR , NP , NL , AN , NC , NZ , NI , NE , NG , NU , NF , MP , NO , OM , PK , PW , PS , PA , PG , PY , PE , PH , PN , PL , PT , PR , QA , RE , RO , RU , RW , BL , SH , KN , LC , MF , PM , VC , WS , SM , ST , SA , SN , RS , SC , SL , SG , SK , SI , SB , SO , ZA , GS , SS , ES , LK , SD , SR , SJ , SZ , SE , CH , SY , TW , TJ , TZ , TH , TL , TG , TK , TO , TT , TN , TR , TM , TC , TV , UG , UA , AE , GB , US , UM , UY , UZ , VU , VE , VN , VI , WF , EH , YE , ZM , ZW , WO }
is_excluded: boolean

AlbumTitleLocalizations: object

title_localizations: object[]

object

title_localization: string
title_localization_language: string , x ∈ { Afrikaans , Arabic , Bengali , Bulgarian , Cantonese , Catalan , Chinese (Simplified) , Chinese (Traditional) , Croatian , Czech , Danish , Dutch , English , Estonian , Finnish , French , German , Greek , Haitian , Hebrew , Hindi , Hungarian , Icelandic , Indonesian , Irish , Italian , Japanese , Kazakh , Korean , Lao , Latin , Latvian , Lithuanian , Malay , Norwegian , Persian , Polish , Portuguese , Punjabi , Romanian , Russian , Sanskrit , Slovak , Slovenian , Spanish , Spanish (Latin America)* , Swedish , Tagalog , Tamil , Telugu , Thai , Turkish , Ukrainian , Urdu , Vietnamese , Zulu }

AppleTrack: object

data: object[]

object

track_id: integer
apple_id: integer

Artist: object

id: string: artist ID
name: string
apple_id: string
bio: string
spotify_uri: string
new_apple_artist: boolean
new_spotify_artist: boolean
amazon_asin: string
isni: string

ArtistNameLocalizations: object

name_localizations: object[]

object

name_localization: string
name_localization_language: string , x ∈ { Afrikaans , Arabic , Bengali , Bulgarian , Cantonese , Catalan , Chinese (Simplified) , Chinese (Traditional) , Croatian , Czech , Danish , Dutch , English , Estonian , Finnish , French , German , Greek , Haitian , Hebrew , Hindi , Hungarian , Icelandic , Indonesian , Irish , Italian , Japanese , Kazakh , Korean , Lao , Latin , Latvian , Lithuanian , Malay , Norwegian , Persian , Polish , Portuguese , Punjabi , Romanian , Russian , Sanskrit , Slovak , Slovenian , Spanish , Spanish (Latin America)* , Swedish , Tagalog , Tamil , Telugu , Thai , Turkish , Ukrainian , Urdu , Vietnamese , Zulu }

BeatportGenresList: object

genre_id: string

ContributorTypes: object

This is the complete list of Contributor Role types. At least one contributor of each type has to be added to all tracks. This validation is applied only for albums created on or after 2024-11-20.

Performing: string , x ∈ { 10_string_bass_guitar , 10_string_guitar , 11_string_guitar , 12_string_acoustic_guitar , 12_string_bass_guitar , 12_string_electric_guitar , 12_string_fiddle , 12_string_guitar , 4_string_banjo , 4_string_guitar , 5_string_banjo , 5_string_bass_guitar , 6_string_banjo , 6_string_bass_guitar , 7_string_banjo , 7_string_bass_guitar , 7_string_guitar , 8_string_bass_guitar , 8_string_guitar , 9_string_guitar , a_cappella_ensemble , accompaniment , accordion , accordion_duo , acoustic_baritone_guitar , acoustic_bass_guitar , acoustic_fretless_guitar , acoustic_guitar , acoustic_rhythm_guitar , acoustic_slide_guitar , actor , additional_vocals , african_percussion , all_instruments , alphorn , alto_clarinet , alto_flute , alto_guitar , alto_horn , alto_lute , alto_recorder , alto_saxophone , alto_tenor_vocal , alto_trombone , alto_viol , alto_viola , alto_viola_da_gamba , alto_violin , alto_vocal , alto_zither , announcer , appalachian_dulcimer , archlute , army_band , arp_synthesizer , assistant_conductor , assistant_director , assistant_programming , associate_conductor , audio_source_artist , autoharp , b_flat_clarinet , baby_bass , background_vocals , baglama , bagpipes , bajo_quinto , bajo_sexto , balafon , balalaika , ballet_orchestra , bamboo_flute , bamboo_saxophone , band , band_conductor , band_leader , bandola , bandoneon , bandura , bandurria , banjo , banjolin , bansuri , barbat , baritone_guitar , baritone_horn , baritone_saxophone , baritone_trombone , baritone_violin , baritone_vocal , baroque_alto_trombone , baroque_bass_trombone , baroque_bassoon , baroque_bassoon_ensemble , baroque_brass_ensemble , baroque_cello , baroque_chamber_orchestra , baroque_choir , baroque_flute , baroque_guitar , baroque_harp , baroque_lute , baroque_music_ensemble , baroque_music_string_ensemble , baroque_music_vocal_ensemble , baroque_music_wind_ensemble , baroque_oboe , baroque_opera_orchestra , baroque_orchestra , baroque_quartet , baroque_recorder , baroque_trio , baroque_trumpet , baroque_viola , baroque_violin , baroque_wind_ensemble , barrel_organ , baryton , bass , bass_banjo , bass_baritone_vocal , bass_clarinet , bass_drum , bass_flute , bass_flute_a_bec , bass_guitar , bass_harmonica , bass_harp , bass_horn , bass_lute , bass_marimba , bass_oboe , bass_recorder , bass_saxophone , bass_synthesizer , bass_trombone , bass_trumpet , bass_viola_da_gamba , bass_violin , bass_vocal , basset_clarinet , basset_horn , basset_recorder , basso_continuo , bassoon , bassoon_quartet , bata_drums , bayan , beatbox , beats , bells , bendir , berimbau , birbyne , biwa , bodhran_drum , bongos , bouzouki , boy_soprano_vocal , boys_choir , brass , brass_and_organ_ensemble , brass_band , brass_conductor , brass_ensemble , brass_instrument , brass_octet , brass_orchestra , brass_quartet , brass_quintet , brass_septet , bugle , bukkehorn , button_accordion , byzantine_lyra , c_melody_saxophone , cabasa , cajon , cajun_fiddle , cantor , carillon , cast , castanets , cathedral_choir , cavaquinho , caxixi , celesta , cello , cello_duo , cello_octet , cello_quartet , celtic_flute , celtic_harp , chalumeau , chamber_choir , chamber_music_ensemble , chamber_orchestra , chamber_organ , chamberlain_strings , chant_conductor , chant_vocals , chapman_stick , charango , childrens_choir , childrens_vocals , chimes , chinese_flute , chinese_traditional_music_ensemble , chitarrone , choir , choir_boy , choir_conductor , choir_director , choral_conductor , chorus , chorus_conductor , chorus_director , christmas_carols_ensemble , chromatic_harmonica , cimbalom , cittern , clap_stick , claps , clarinet , clarinet_orchestra , clarinet_quartet , clarinet_trio , classical_ensemble , classical_guitar , classical_vocals , claves , clavichord , clavier , clavinet , comedian , commentary , concertina , conductor , congas , contemporary_music_chamber_orchestra , contemporary_music_ensemble , contemporary_music_orchestra , contemporary_music_quartet , contemporary_music_trio , continuo , contrabass , contrabass_clarinet , contrabass_flute , contrabass_recorder , contrabass_saxophone , contrabass_trombone , contrabassoon , contralto_clarinet , contralto_vocal , cornet , cornetto , corno_da_caccia , coro , counter_tenor_vocal , cowbell , crossover_duo , crossover_ensemble , crossover_trio , crotales , crumhorn , cuatro , cuatro_venezolano , cuica , cymbals , daf , dan_tranh , dancer , darbuka , daxophone , dhol , dialogue , didgeridoo , dilruba , dizi , dj , djembe , dobro , dojo , domra , double_bass , double_bass_ensemble , double_bass_quartet , double_flute , double_recorder , doumbek , drum_machine , drums , duduk , duet_vocals , dulcian , dulcimer , dutar , e_bow , early_music_chamber_choir , early_music_chamber_orchestra , early_music_choir , early_music_duo , early_music_ensemble , early_music_instrument , early_music_orchestra , early_music_trio , early_music_vocal_ensemble , electric_banjo , electric_bass_guitar , electric_cello , electric_fretless_guitar , electric_guitar , electric_mandolin , electric_piano , electric_sitar , electric_upright_bass , electric_violin , electronic_instrument , electronic_music_ensemble , electronic_percussion , electronics , english_horn , ensemble , ensemble_director , ensemble_role , erhu , euphonium , ewi , fairlight_cmi , farfisa , fiddle , fife , finger_cymbals , finger_snaps , first_cello , first_violin , flageolet , flamenco_cajon , flamenco_guitar , flugelhorn , flute , flute_ensemble , flute_quartet , flute_quintet , folk_music_ensemble , folk_music_orchestra , foot_stomping , fortepiano , frame_drum , french_horn , fretless_bass_guitar , fretless_guitar , fujara , funde , fuzz_guitar , gadulka , gamelan , gang_vocals , ghatam , girls_choir , gittern , glass_harmonica , glockenspiel , gong , gospel_choir , gothic_harp , great_bass_recorder , gregorian_chant_choir , gregorian_chant_ensemble , group , guicharo , guira , guiro , guitar , guitar_duo , guitar_quartet , guitar_synthesizer , guitar_trio , guitarron , gut_string_guitar , haegeum , hammered_dulcimer , hammond_organ , hand_claps , handbell_choir , hang , hardanger_fiddle , harmonica , harmonium , harmony_vocals , harp , harp_ensemble , harpsichord , haute_contre_vocals , hawaiian_guitar , heckelphone , herald_trumpet , hi_hat , hi_string_guitar , hichiriki , high_tenor_vocal , historical_bassoon , historical_guitar , historical_harp , horn , horn_conductor , horn_ensemble , horn_quartet , horn_section , host , hurdy_gurdy , indian_flute , instrument , instrumental_ensemble , interviewee , interviewer , intro_vocals , introduction_by , irish_flute , irish_whistle , japanese_flute , jaw_harp , kalimba , kamancheh , kantele , kanun , kaval , kazoo , keyboard_bass , keyboard_instrument , keyboard_synth , keyboards , keytar , khene , kora , koto , kugo , lap_cello , lap_slide_guitar , lap_steel_guitar , lautenwerck , lead_acoustic_guitar , lead_electric_guitar , lead_guitar , lead_violin , lead_vocals , leader , leaf , lirone , loops , low_whistle , lowrey_organ , lute , lute_duo , lyra_viol , lyre , lyricon , mandocello , mandola , mandolin , maracas , marching_band , marimba , mbira , mc , medieval_flute , medieval_harp , medieval_music_ensemble , medieval_music_quartet , medieval_music_vocal_ensemble , mellophone , mellotron , melodeon , melodica , mens_choir , metallophone , mezzo_soprano_vocal , mezzo_violin , military_band , military_choir , mixed_artist , modular_synth , mong , moog , mouth_organ , mridangam , musette , music_director , musical_saw , musician , muted_trombone , muted_trumpet , narrator , native_american_flute , natural_horn , ney , nyckelharpa , nylon_string_guitar , oboe , oboe_da_caccia , oboe_damore , ocarina , omnichord , ondes_martenot , opera_and_ballet_orchestra , opera_choir , opera_company , opera_orchestra , ophicleide , orchestra , orchestra_conductor , orchestra_director , orchestra_leader , orchestra_manager , organ , organ_pedals , organetto , other_brass_instrument , other_instrument , other_keyboard_instrument , other_percussion_instrument , other_performer , other_string_instrument , other_wind_instrument , other_woodwind_instrument , oud , paetzold_contrabass_recorder , pakhavaj , palmas , pan_flute , pandeiro , panderos , panpipes , pardessus_de_viole , parlor_guitar , pedal_steel_guitar , penny_whistle , percussion , percussion_duo , percussion_ensemble , percussion_instrument , percussion_quartet , performer , period_instrument_orchestra , philharmonic_choir , philharmonic_orchestra , piano , piano_duo , piano_quartet , piano_quintet , piano_trio , piccolo_bass , piccolo_flute , piccolo_trumpet , pierrot_ensemble , pipa , pipe , pipe_ensemble , pipe_organ , pipes , playback_singer , pocket_trumpet , pops_orchestra , portuguese_guitar , positive_organ , post_horn , prepared_piano , primera_voz , principal , programming , psaltery , pump_organ , radio_choir , radio_orchestra , ragga_mc , rap , realization_figured_bass , rebab , rebec , recorder , recorder_ensemble , recorder_quartet , recorder_quintet , reed_organ , reeds , renaissance_flute , renaissance_guitar , renaissance_music_chamber_choir , renaissance_music_ensemble , renaissance_music_quartet , renaissance_music_wind_ensemble , repeater_drum , requinto_guitar , requinto_jarocho , resonator_guitar , rhodes_piano , rhythm_guitar , romantic_guitar , romantic_music_ensemble , russian_folk_music_ensemble , russian_guitar , sabar_ensemble , sackbut , sacred_music_choir , sacred_music_ensemble , sampled_artist , sampler , santur , sarangi , sarod , saxello , saxophone , saxophone_quartet , saxophone_quintet , scratches , screams , second_cello , second_violin , second_vocals , segunda_voz , serpent , shaker , shakuhachi , shawm , shehnai , shekere , sheng , sho , shouts , sistrum , sitar , sleigh_bells , slide_guitar , slide_trumpet , slide_whistle , snare_drum , solo , sopilka , sopranino_recorder , sopranino_saxophone , soprano_clarinet , soprano_cornet , soprano_flute , soprano_recorder , soprano_saxophone , soprano_trombone , soprano_viola_da_gamba , soprano_violin , soprano_vocal , sound_effects , sousaphone , speaker , spinet , spoken_word , spoons , steel_drum , steel_guitar , streichmelodion , string_conductor , string_ensemble , string_instrument , string_octet , string_orchestra , string_quartet , string_quintet , string_section , string_sextet , string_trio , strings , stritch , stroh_violin , studio_choir , studio_orchestra , stylophone , surbahar , surdo , swing_music_band , symphonic_band , symphony_choir , symphony_chorus , symphony_orchestra , synclavier , synth_bass , synth_guitar , synth_pads , synth_percussion , synth_strings , synthesizer , synthesizer_programming , tabla , tabor , tafelklavier , taiko_drums , talkbox , talking_drum , tamborim , tamboura , tambourine , tanbur , tango_ensemble , tanpura , taonga_puoro , tap_dancer , tape , tar , temple_blocks , tenor_banjo , tenor_drums , tenor_guitar , tenor_horn , tenor_recorder , tenor_sackbut , tenor_saxophone , tenor_trombone , tenor_viol , tenor_viola_da_gamba , tenor_violin , tenor_vocal , theorbo , theremin , tibetan_bowls , timbales , timpani , tin_whistle , toasting , tom_toms , toy_piano , transverse_flute , trautonium , traverso , treble_recorder , treble_viol , treble_viola_da_gamba , treble_violin , treble_vocal , tres , triangle , trombone , trombone_quartet , trumpet , trumpet_duo , trumpet_ensemble , tuba , tuba_ensemble , tubular_bells , turntables , txistu , udu , uilleann_pipes , ukulele , upright_bass , upright_piano , valve_trombone , veena , vibes , vibraphone , vibraslap , vielle , vihuela , viol , viol_consort , viola , viola_da_gamba , viola_da_gamba_ensemble , viola_damore , viola_quartet , violetta , violin , violin_duo , violin_ensemble , violoncello , violone , violone_grosso , virginal , vocal_conductor , vocal_director , vocal_duo , vocal_effects , vocal_ensemble , vocal_quartet , vocal_trio , vocaloid , vocals , vocoder , washboard , whistle , whistling , wind_chimes , wind_ensemble , wind_instrument , wind_octet , wind_orchestra , wind_quartet , wind_quintet , wind_trio , womens_choir , wood_block , wood_flute , wood_recorder , wood_whistle , woodwind_ensemble , woodwind_instrument , woodwind_quintet , woodwinds , worship_leader , wurlitzer_piano , xylophone , xylorimba , youth_choir , youth_orchestra , zarb , zither }
Composition & Lyrics: string , x ∈ { adapter , adapter_religious_text , adapter_traditional_text , arranger , arranger_traditional , assistant_arranger , based_on_the_work_of , book , brass_arranger , cadenza , choir_arranger , chorus_arranger , co_arranger , co_composer , composer , composition_ascribed_to , copyist , horn_arranger , keyboard_arranger , librettist , libretto_editing , lyricist , orchestrator , percussion_arranger , poetry , reconstruction , revision , saxophone_arranger , score_editor , score_preparation , screenwriter , songwriter , string_arranger , text , transcription , translation , trumpet_arranger , vocal_adapter , vocal_arranger , wind_arranger , woodwind_arranger , writer }
Production & Engineering: string , x ∈ { additional_engineer , additional_producer , art_production , assistant_editing_engineer , assistant_engineer , assistant_mastering_engineer , assistant_mixing_engineer , assistant_producer , assistant_recording_engineer , assistant_strings_engineer , associate_producer , audio_processing , audio_restoration , audio_technician , balance_engineer , bass_technician , camera_operator , choreography , cinematography , co_producer , compilation_producer , computer_graphics , concert_producer , costume_design , cover_art , cover_photography , creative_director , drawing , drum_technician , editing_engineer , engineer , engraving , equipment_technician , executive_producer , film_director , film_editor , film_producer , graphic_design , guitar_technician , harpsichord_technician , harpsichord_tuner , illustrator , keyboard_technician , lighting_design , lithography , live_mixing_engineer , live_production , live_recording_engineer , mastering_engineer , mixing_engineer , music_supervisor , organ_technician , original_engineering , original_producer , other_pe , overdub_engineer , package_design , paintings , photo_editor , photography , piano_technician , piano_tuner , portraits , post_production_assistant , post_production_director , post_production_editor , post_production_engineer , post_production_mixing_engineer , post_production_supervisor , producer , recording_engineer , recording_supervisor , recording_technician , reissue_producer , remix_producer , remixer , research , score_producer , set_designer , sound_design , soundtrack_producer , spatial_audio_engineer , spatial_mastering_engineer , spatial_mixing_engineer , special_effects , stage_director , stage_manager , stage_technician , strings_engineer , studio_personnel , studio_technician , stylist , tape_editor , tape_operator , tape_preparation , tonmeister , transfer_engineer , typesetting , typography , video_director , video_editor , video_producer , video_production , videographer , vocal_mixing_engineer , vocal_producer , vocal_recording_engineer , wardrobe }

Distribution: object

id: object

entity ID

dsp: object

dsp name

message: string: per DSP error description
status: string , x ∈ { error , ok }

message: string

global error description (if any)

status: string , x ∈ { error }

DistributionCancelResponse: object

status: string , x ∈ { ok , error }
message: string

DistributionStatuses: object

album_id: int
dsp_site: string , x ∈ { DSPs }
request_type: string , x ∈ { PUBLISH , TAKEDOWN }
request_at: dateTime
response_status: string , x ∈ { ASSET_MISSING , SUCCESS , WORKING , FAILURE , REJECTED }
response_at: dateTime
failure_reason: string
message: string

DspsList: object

dsps: object[]

GenresList: object

genre_id: string

GetAllResponse: object

items: object[]: Various types
itemsCount: int: Total items count.
page: int: Page number.
perPage: int: Number items per page.

ItunesStatus: object

apple_id: string
content_status: object
info: object[]
vendor_id: string

SalesTrends: object[]

object

report_date: dateTime
value: int

SmartURL: object

success: boolean
link: string
error: string

StatementsDownload: object

download_url: string

Track: object

id: int

album_id: int

artist_id: int

c_line: string (YYYY Copyright)

Track c line.

composer: string

cover_song: int , x ∈ { 0 , 1 }

disc_number: int

explicit: int , x ∈ { 0 , 1 }

instant_grat_release_date: dateTime

isrc: string (US-NNN-YY-DDDDD)

label_track_id: string

lyrics: string

p_line: string (YYYY Copyright)

Track p line.

position: int

producer: string

remixer: string

title: string

track: object

filename: string

track_spatial_file: string (url)

track_language: string , x ∈ { Afrikaans , Arabic , Bulgarian , Cantonese , Catalan , Chinese , Croatian , Czech , Danish , Dutch , English , Estonian , Finnish , French , German , Greek , Hebrew , Hindi , Hungarian , Icelandic , Indonesian , Italian , Japanese , Kazakh , Korean , Lao , Latvian , Lithuanian , Malay , None , Norwegian , Polish , Portuguese , Romanian , Russian , Slovak , Slovenian , Spanish , Swedish , Tagalog , Tamil , Telugu , Thai , Turkish , Ukrainian , Urdu , Vietnamese , Zulu }

version: string

TrackArtists: object

artists: object[]

object

artist_id: integer
role: string: Allowed roles are: any role from Contributor Roles + ["primary", "featuring"]

TrackPreview: object

id: integer
dsp_site: string , x ∈ { itunes , tiktok , youtube }
duration: integer
start_time: integer
start_date: date

TrackPreviews: object

previews: object[]

object

id: integer
dsp_site: string , x ∈ { itunes , tiktok , youtube }
duration: integer
start_time: integer
start_date: date

TrackTitleLocalizations: object

title_localizations: object[]

object

title_localization: string
title_localization_language: string , x ∈ { Afrikaans , Arabic , Bengali , Bulgarian , Cantonese , Catalan , Chinese (Simplified) , Chinese (Traditional) , Croatian , Czech , Danish , Dutch , English , Estonian , Finnish , French , German , Greek , Haitian , Hebrew , Hindi , Hungarian , Icelandic , Indonesian , Irish , Italian , Japanese , Kazakh , Korean , Lao , Latin , Latvian , Lithuanian , Malay , Norwegian , Persian , Polish , Portuguese , Punjabi , Romanian , Russian , Sanskrit , Slovak , Slovenian , Spanish , Spanish (Latin America)* , Swedish , Tagalog , Tamil , Telugu , Thai , Turkish , Ukrainian , Urdu , Vietnamese , Zulu }

TrendsReport: object

dsp_site: string
report_date: date
download_url: string: Presigned AWS S3 link that expires in 2 hours

User: object

id: int
email: string (e-mail)
password: string