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

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
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 }
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	string (numeric string 10..13 chars [will be generated if not provided])
various_artists	formData	boolean

Uses default content-types: application/json

200 OK: create new album

Album
400 Bad Request: Bad request. Validation error.
403 Forbidden: Authorization required
415 Unsupported Media Type: Unsupported Media Type

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
415 Unsupported Media Type: Unsupported Media Type

Delete Artist from Album

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

Delete Artist from Album


artist_id		formData	int
role		formData	string , x ∈ { primary , featuring , composer , remixer , producer , songwriter , lyricist , mastering engineer }

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		formData	string , x ∈ { primary , featuring , composer , remixer , producer , songwriter , lyricist , mastering engineer }

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
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
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		formData	string , x ∈ { primary , featuring , composer , remixer , producer , songwriter , lyricist , mastering engineer }

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		formData	string , x ∈ { primary , featuring , composer , remixer , producer , songwriter , lyricist , mastering engineer }

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

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 , x ∈ { primary , featuring , composer , remixer , producer , songwriter , lyricist , mastering engineer }

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

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 , x ∈ { primary , featuring , composer , remixer , producer , songwriter , lyricist , mastering engineer }

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 }

User: object

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