### TrackPreview Object Schema Source: https://api.dashgo.com/index Schema for track preview information, specifying the DSP site, duration, start time, and start date of the preview. ```APIDOC TrackPreview: object id: integer dsp_site: string Allowed Values: itunes, tiktok, youtube duration: integer start_time: integer start_date: date ``` -------------------------------- ### Manage Track Previews API Endpoints Source: https://api.dashgo.com/index Provides API endpoints for managing track previews, including retrieving, adding, and deleting previews. Previews can have various attributes like duration, start time, and associated DSP sites. ```APIDOC GET /api/v2/tracks/{track_id}/previews - Description: Returns list of track previews - Content-Type: application/json - Responses: - 200 OK: List all track previews (Schema: 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 POST /api/v2/tracks/{track_id}/previews - Description: Add track preview - Content-Type: application/json - Parameters (formData): - duration: integer (For iTunes duration is always 30.) - start_time: integer - start_date: date (YYYY-mm-dd) (Only supported by Youtube.) - dsp_site: string (Allowed values: itunes, tiktok, youtube) - Responses: - 200 OK: Preview Successfully Added to Track (Schema: 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 /api/v2/tracks/{track_id}/previews/{preview_id} - Description: Delete track preview - Content-Type: application/json - Parameters (formData): - preview_id: integer - Responses: - 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 /api/v2/tracks/{track_id}/previews/{preview_id} - Description: Returns track preview - Content-Type: application/json - Responses: - 200 OK: Track preview (Schema: 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 ``` -------------------------------- ### TrackPreviews API Object Definition Source: https://api.dashgo.com/index Defines the structure for track preview objects, including identifier, DSP site, duration, and start times. ```APIDOC TrackPreviews: object previews: object[] id: integer dsp_site: string (enum: itunes, tiktok, youtube) duration: integer start_time: integer start_date: date ``` -------------------------------- ### Manage Albums API Endpoints Source: https://api.dashgo.com/index This section describes the API endpoints for managing albums. It includes operations for retrieving a list of albums with pagination and search capabilities, and for creating new album entries. Details on parameters and response codes are provided for the GET operation. ```APIDOC /api/v2/albums GET /api/v2/albums/ - Description: Returns list of albums. - Parameters: - page (int, path): pagination - search (string, path): search album by name - upc (string, path): search album by UPC - Responses: - 200 OK: List all albums (Schema: GetAllResponse) - 403 Forbidden: Authorization required POST /api/v2/albums/ - Description: Create new album ``` -------------------------------- ### GetAllResponse Object Schema Source: https://api.dashgo.com/index A generic response schema for 'get all' operations, providing pagination details and the total count of items. The 'items' array can contain various types of objects. ```APIDOC GetAllResponse: object items: object[] Various types itemsCount: int Total items count. page: int Page number. perPage: int Number items per page. ``` -------------------------------- ### API Documentation for Artist Core Operations Source: https://api.dashgo.com/index Endpoints for managing artists, including retrieving all artists and creating new ones. ```APIDOC Path: /api/v2/artists/ GET: Get all artists POST: Create new artist ``` -------------------------------- ### API Documentation for SmartURL Generation Source: https://api.dashgo.com/index Endpoint to generate and return a SmartURL link. ```APIDOC Path: /api/v2/smart_url GET: Generate and return SmartURL link ``` -------------------------------- ### API Documentation for DSPs Source: https://api.dashgo.com/index Endpoint to retrieve a list of all available Digital Service Providers (DSPs). ```APIDOC Path: /api/v2/dsps/ GET: Get all DSPs ``` -------------------------------- ### API Documentation for Album Core Operations Source: https://api.dashgo.com/index Endpoints for managing albums, including retrieving all albums and creating new ones. ```APIDOC Path: /api/v2/albums/ GET: Get all albums POST: Create new album ``` -------------------------------- ### API Documentation for Statements Download Source: https://api.dashgo.com/index Endpoint to retrieve a download link for financial statements by month. ```APIDOC Path: /api/v2/statements/download GET: Get statements download link by month ``` -------------------------------- ### API Documentation for Genres Source: https://api.dashgo.com/index Endpoint to retrieve a list of all available genres. ```APIDOC Path: /api/v2/genres/ GET: Get all genres ``` -------------------------------- ### API Documentation for Beatport Genres Source: https://api.dashgo.com/index Endpoint to retrieve a list of all available Beatport genres. ```APIDOC Path: /api/v2/beatport_genres/ GET: Get all Beatport genres ``` -------------------------------- ### Retrieve All DSPs Source: https://api.dashgo.com/index Fetches a list of all available Digital Service Providers (DSPs). This list is essential for specifying target platforms when initiating or managing distribution methods. ```APIDOC GET /api/v2/dsps/ - Returns list of DSPs for use in distribution methods. - Responses: - 200 OK: List all DSPs [DspsList] - 403 Forbidden: Authorization required ``` -------------------------------- ### Dashgo API General Information Source: https://api.dashgo.com/index Provides foundational details about the Dashgo API, including its base URL, current version, default response content types, and supported communication schemes. ```APIDOC Base URL: /api/v2, Version: 2.0.0 Default response content-types: application/json Schemes: https ``` -------------------------------- ### API Documentation for Album DSP Territories Management Source: https://api.dashgo.com/index Endpoints for managing DSP (Digital Service Provider) territories associated with a specific album, allowing for addition, retrieval, update, and deletion. ```APIDOC Path: /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 Documentation for SmartURL Analytics Source: https://api.dashgo.com/index Endpoint to generate and return an analytics page link for a SmartURL. ```APIDOC Path: /api/v2/smart_url/analytics GET: Generate and return analytics page link for SmartURL ``` -------------------------------- ### API Documentation for Album Artist Management Source: https://api.dashgo.com/index Endpoints for managing artists associated with a specific album, including adding, retrieving, and deleting artists. ```APIDOC Path: /api/v2/albums/{album_id}/artists DELETE: Delete Artist from Album GET: Get Album Artists List POST: Add Artist to Album ``` -------------------------------- ### API Documentation for Apple Analytics Integration Source: https://api.dashgo.com/index Endpoints for interacting with Apple sales analytics, providing documentation and direct access to track-based analytics. ```APIDOC Path: /api/v2/apple_analytics GET: Return sales analytics Apple API documentation POST: Return sales analytics by tracks using Apple API directly ``` -------------------------------- ### API Documentation for Album Distribution Source: https://api.dashgo.com/index Endpoints for managing the distribution status of albums, including publishing, checking status, and takedown operations. ```APIDOC Path: /api/v2/distribute/albums DELETE: Takedown albums GET: Distribution status POST: Publish albums ``` -------------------------------- ### Create New Album API Endpoint Source: https://api.dashgo.com/index Documents the API endpoint for creating a new album. This endpoint accepts various album metadata as form data, including copyright lines, release dates, titles, genres, territorial restrictions, and media files. ```APIDOC POST /api/v2/albums/ Description: Create new album. Content-Type: application/json Parameters (formData): - c_line: string (YYYY Copyright) - label_name: string - p_line: string (YYYY Copyright) - release_date: date (YYYY-mm-dd) - sale_start_date: date (YYYY-mm-dd) - title: string - genre: string, x ∈ { genres } - album_genres: string ([{\"genre\":\"dance_elec\"},{\"genre\":\"rap\"}, ...]), x ∈ { genres } - album_territories: string ([{\"territory\":\"UK\"},{\"territory\":\"US\"},...]), x ∈ { territories } - beatport_genre: string, x ∈ { beatport_genres } - cover: file - exclude_territories: string ([{\"territory\":\"UK\"},{\"territory\":\"US\"},...]), x ∈ { territories } - 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 } - preorder_release_date: date (YYYY-mm-dd) - price: float, x ∈ { 9.99, 8.99, 7.99, 6.99, 5.99, 4.99, 3.99, 2.99, 1.99 } - secondary_language: string - track_price: float, x ∈ { 1.29, 0.99, 0.69 } - upc: string (numeric string 10..13 chars [will be generated if not provided]) - various_artists: boolean Responses: - 201 Created: create new album (Returns: Album object) - 400 Bad Request: Bad request. Validation error. - 403 Forbidden: Authorization required ``` -------------------------------- ### API Documentation for Track Management Source: https://api.dashgo.com/index Endpoint to retrieve a list of all tracks. ```APIDOC Path: /api/v2/tracks/ GET: Get all tracks ``` -------------------------------- ### API Documentation for iTunes Distribution Status Source: https://api.dashgo.com/index Endpoint to retrieve the iTunes response for a distributed album. ```APIDOC Path: /api/v2/distribute/itunes/status GET: Get Itunes response for distributed album ``` -------------------------------- ### Statements Download API Source: https://api.dashgo.com/index Provides an endpoint to retrieve a download link for monthly statements. ```APIDOC GET /api/v2/statements/download Description: Return statements download link by month Parameters: - month (int, formData): month (x ∈ { 1 , 2 , 3 , 4 , 5 , 6 , 7 , 8 , 9 , 10 , 11 , 12 }) - year (int, formData): year (x ∈ { 2015 , 2016 , ... }) Responses: - 200 OK: Show download link (Schema: StatementsDownload) - 400 Bad Request: Bad request. Validation error. - 403 Forbidden: Authorization required - 404 Not Found: Report not found ``` -------------------------------- ### API Documentation for Artist Name Localizations Source: https://api.dashgo.com/index Endpoints for managing localized names for a specific artist, including adding, retrieving, and deleting localizations. ```APIDOC Path: /api/v2/artists/{artist_id}/name_localizations DELETE: Delete artist name localization GET: Get artist name localizations POST: Add artist name localization ``` -------------------------------- ### API Documentation for Album Title Localizations Source: https://api.dashgo.com/index Endpoints for managing localized titles for a specific album, including adding, retrieving, and deleting localizations. ```APIDOC Path: /api/v2/albums/{album_id}/title_localizations DELETE: Delete album title localization GET: Get album title localizations POST: Add album title localization ``` -------------------------------- ### StatementsDownload Object Schema Source: https://api.dashgo.com/index Schema for providing a URL to download statements. ```APIDOC StatementsDownload: object download_url: string ``` -------------------------------- ### API Documentation for Specific Album Operations Source: https://api.dashgo.com/index Endpoints for retrieving and updating a single album by its ID. ```APIDOC Path: /api/v2/albums/{album_id} GET: Get single album by id PUT: Update album by id ``` -------------------------------- ### Manage Tracks API Endpoints Source: https://api.dashgo.com/index This section details the API endpoints for managing tracks, including operations for creating, retrieving, updating, and deleting tracks, as well as managing associated artists, previews, and title localizations. It covers various HTTP methods for comprehensive track resource management. ```APIDOC /api/v2/tracks POST /api/v2/tracks - Description: Create new track DELETE /api/v2/tracks/{track_id} - Description: Delete single track by id GET /api/v2/tracks/{track_id} - Description: Get single track by id PUT /api/v2/tracks/{track_id} - Description: Update track by id DELETE /api/v2/tracks/{track_id}/artists - Description: Delete Artist from Track GET /api/v2/tracks/{track_id}/artists - Description: Get Track Artists List POST /api/v2/tracks/{track_id}/artists - Description: Add Artist to Track GET /api/v2/tracks/{track_id}/previews - Description: Get track previews POST /api/v2/tracks/{track_id}/previews - Description: Add track preview DELETE /api/v2/tracks/{track_id}/previews/{preview_id} - Description: Delete track preview GET /api/v2/tracks/{track_id}/previews/{preview_id} - Description: Get track preview DELETE /api/v2/tracks/{track_id}/title_localizations - Description: Delete track title localization GET /api/v2/tracks/{track_id}/title_localizations - Description: Get track title localizations POST /api/v2/tracks/{track_id}/title_localizations - Description: Add track title localization ``` -------------------------------- ### ItunesStatus Object Schema Source: https://api.dashgo.com/index Schema detailing the status of content specifically within iTunes, including Apple ID, content status, and vendor information. ```APIDOC ItunesStatus: object apple_id: string content_status: object info: object[] vendor_id: string ``` -------------------------------- ### Artist Management API Endpoints Source: https://api.dashgo.com/index Provides API endpoints for managing artists, including listing, creating, updating, deleting, and managing artist name localizations. ```APIDOC GET /api/v2/artists/ Description: Returns list of artists. Parameters: page: pagination (path, int) search: search artist by name (path, string) Responses: 200 OK: List all artists (GetAllResponse) 403 Forbidden: Authorization required POST /api/v2/artists/ Description: Create new artist. Parameters: 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) Responses: 200 OK: Artist created (Artist) 400 Bad Request: Bad request. Validation error. 401 Unauthorized: Authorization required DELETE /api/v2/artists/{artist_id} Description: Delete artist. Parameters: id: (path, int) Responses: 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 /api/v2/artists/{artist_id} Description: Returns single artist. Responses: 200 OK: Get single artist by id (Artist) 401 Unauthorized: Authorization required 404 Not Found: Artist not found PUT /api/v2/artists/{artist_id} Description: Update artist. Parameters: name: (formData, string) amazon_asin: (formData, string) apple_id: (formData, string) bio: (formData, string) isni: (formData, string) spotify_uri: (formData, string) Responses: 200 OK: Artist updated (Artist) 400 Bad Request: Bad request. Validation error. 401 Unauthorized: Authorization required DELETE /api/v2/artists/{artist_id}/name_localizations Description: Delete artist name localization. Parameters: 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 }) Responses: 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 /api/v2/artists/{artist_id}/name_localizations Description: Returns list of artist name localizations. Responses: 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 ``` -------------------------------- ### SmartURL Generation and Analytics API Source: https://api.dashgo.com/index Provides endpoints for generating SmartURL links and retrieving analytics page links for SmartURLs. ```APIDOC GET /api/v2/smart_url Description: Generate and return SmartURL link Parameters: - album_id (int, formData): Album ID - regenerate (boolean, formData): force regenerate link Responses: - 200 OK: Show result of generating SmartURL link (Schema: 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 ``` ```APIDOC GET /api/v2/smart_url/analytics Description: Generate and return analytics page link for SmartURL Parameters: - album_id (int, formData): Album ID Responses: - 200 OK: Show result of generating analytics page link (Schema: 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 ``` -------------------------------- ### User API Object Definition Source: https://api.dashgo.com/index Defines the structure for a user object, including identifier, email, and password. ```APIDOC User: object id: int email: string (e-mail) password: string ``` -------------------------------- ### Manage Album Distribution Source: https://api.dashgo.com/index Provides comprehensive functionality for managing album distribution, including publishing, taking down, and checking the status of albums across various DSPs. This set of endpoints allows for full control over the distribution lifecycle. ```APIDOC DELETE /api/v2/distribute/albums - Takedown albums. - Parameters: - album_ids (JSON, formData): JSON array of album IDs to takedown. - dsp (JSON, formData): JSON array of DSPs to takedown from. - Responses: - 200 OK: Takedown albums [Distribution] - 400 Bad Request: Bad Request - 403 Forbidden: Authorization required GET /api/v2/distribute/albums - Distribution status. - Parameters: - album_id (int, path): The ID of the album. - dsp_site (string, path): The name of the DSP. - Responses: - 200 OK: Distribution statuses list [DistributionStatuses] - 403 Forbidden: Authorization required - 404 Not Found: Item not found. POST /api/v2/distribute/albums - Publish albums. - Parameters: - album_ids (JSON, formData): JSON array of album IDs to publish. - dsp (JSON, formData): JSON array of DSPs to publish to. - Responses: - 200 OK: Published albums [Distribution] - 400 Bad Request: Bad request. Validation error. - 403 Forbidden: Authorization required ``` -------------------------------- ### API Object: Artist Source: https://api.dashgo.com/index Schema definition for the Artist object, detailing artist information including IDs, names, and streaming service links. ```APIDOC 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 ``` -------------------------------- ### API Documentation for Sales Trends Source: https://api.dashgo.com/index Endpoint to retrieve general sales trend data. ```APIDOC Path: /api/v2/sales_trends GET: Sales trends ``` -------------------------------- ### Retrieve All Genres Source: https://api.dashgo.com/index Fetches a comprehensive list of all available music genres. This endpoint is used to populate genre selection options for various purposes, including distribution settings. ```APIDOC GET /api/v2/genres/ - Returns list of genres for use in distribution methods. - Responses: - 200 OK: List all genres [GenresList] - 403 Forbidden: Authorization required ``` -------------------------------- ### API Object: Album Source: https://api.dashgo.com/index Schema definition for the Album object, detailing its properties and their types, including release dates, genres, and associated artists. ```APIDOC 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 ``` -------------------------------- ### API Documentation for Specific Artist Operations Source: https://api.dashgo.com/index Endpoints for retrieving, updating, and deleting a single artist by their ID. ```APIDOC Path: /api/v2/artists/{artist_id} DELETE: Delete artist GET: Get single artist by id PUT: Update artist ``` -------------------------------- ### DistributionStatuses Object Schema Source: https://api.dashgo.com/index Defines the detailed status of a distribution request for a specific album and DSP. It includes request type, timestamps, and reasons for failure. ```APIDOC DistributionStatuses: object album_id: int dsp_site: string Allowed Values: DSPs request_type: string Allowed Values: PUBLISH, TAKEDOWN request_at: dateTime response_status: string Allowed Values: ASSET_MISSING, SUCCESS, WORKING, FAILURE, REJECTED response_at: dateTime failure_reason: string message: string ``` -------------------------------- ### API Object: AlbumDspTerritories Source: https://api.dashgo.com/index Schema definition for the AlbumDspTerritories object, specifying DSP (Digital Service Provider) territories and exclusion status for an album. ```APIDOC 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 ``` -------------------------------- ### Manage Track Artists API Endpoints Source: https://api.dashgo.com/index Provides API endpoints for retrieving and adding artists associated with a specific track. This includes fetching a list of all artists for a track and adding new artists with specified roles. ```APIDOC GET /api/v2/tracks/{track_id}/artists - Description: Returns list of track artists - Content-Type: application/json - Responses: - 200 OK: List all track artists (Schema: TrackArtists) - 401 Unauthorized: Authorization required - 403 Forbidden: Access to Album is forbidden - 404 Not Found: Track not found POST /api/v2/tracks/{track_id}/artists - Description: Add Artist to Track - Content-Type: application/json - Parameters (formData): - artist_id: int - role: string (Allowed roles: any role from ContributorTypes + "primary", "featuring") - Responses: - 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 ``` -------------------------------- ### Retrieve iTunes Distribution Status Source: https://api.dashgo.com/index Retrieves the distribution status specifically for iTunes for a given album. This provides details on the album's progress and state within the iTunes distribution pipeline. ```APIDOC GET /api/v2/distribute/itunes/status - Itunes response for distributed album. - Parameters: - album_id (int, path): The ID of the album. - Responses: - 200 OK: Itunes response [ItunesStatus] - 400 Bad Request: Bad request. Validation error. - 403 Forbidden: Authorization required ``` -------------------------------- ### API Documentation for Cancelling Album Distribution Source: https://api.dashgo.com/index Endpoint to cancel pending album distribution requests. ```APIDOC Path: /api/v2/distribute/albums/cancel POST: Cancel pending distribution ``` -------------------------------- ### Retrieve Beatport Genres Source: https://api.dashgo.com/index Fetches a list of all available Beatport genres. This endpoint is typically used to populate genre selection options in distribution methods or other related features. ```APIDOC GET /api/v2/beatport_genres/ - Returns list of Beatport genres for use in distribution methods. - Responses: - 200 OK: List all genres [BeatportGenresList] - 403 Forbidden: Authorization required ``` -------------------------------- ### API Object: ArtistNameLocalizations Source: https://api.dashgo.com/index Schema definition for the ArtistNameLocalizations object, handling localized names for artists across various languages. ```APIDOC 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 } ``` -------------------------------- ### Track Resource API Operations Source: https://api.dashgo.com/index This section details the API endpoints for managing track resources, including creation, retrieval, update, deletion, and management of artists associated with a track. ```APIDOC ### Track Management API #### POST /api/v2/tracks/ Description: Create new track. Parameters: - 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 Responses: - 200 OK: create new track (Returns: Track) - 400 Bad Request: Bad request. Validation error. - 403 Forbidden: Authorization required #### DELETE /api/v2/tracks/{track_id} Description: Delete single track. Parameters: - id (path, int): The ID of the track to delete. Responses: - 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 /api/v2/tracks/{track_id} Description: Returns single track. Parameters: - track_id (path, int): The ID of the track to retrieve. Responses: - 200 OK: Get single track by id (Returns: Track) - 403 Forbidden: Authorization required - 404 Not Found: Item not found. #### PUT /api/v2/tracks/{track_id} Description: Update track data by id. Parameters: - id (path, string): track ID - 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 Responses: - 200 OK: The updated track data (Returns: Track) - 400 Bad Request: Bad request. Validation error. - 403 Forbidden: Authorization required - 404 Not Found: Item not found. #### DELETE /api/v2/tracks/{track_id}/artists Description: Delete Artist from Track. Parameters: - artist_id (formData, int): - role (formData, string): Allowed roles are: any role from Contributor Roles + ["primary", "featuring"] Responses: - 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 ``` -------------------------------- ### DspsList Object Schema Source: https://api.dashgo.com/index Schema for a list of Digital Service Providers (DSPs). This object typically contains an array of DSP objects. ```APIDOC DspsList: object dsps: object[] ``` -------------------------------- ### Retrieve Single Album API Endpoint Source: https://api.dashgo.com/index Documents the API endpoint for retrieving a single album by its unique identifier. This endpoint provides detailed information about a specific album. ```APIDOC GET /api/v2/albums/{album_id} Description: Returns single album. Content-Type: application/json Parameters (path): - album_id: string (Album ID) Responses: - 200 OK: Get single album by id (Returns: Album object) - 403 Forbidden: Authorization required - 404 Not Found: Item not found. ``` -------------------------------- ### API Documentation for Skipped Tracks Analytics Source: https://api.dashgo.com/index Endpoint to retrieve analytics data for skipped tracks. ```APIDOC Path: /api/v2/sales_trends/skips GET: Skipped tracks analytics ``` -------------------------------- ### API Object: AlbumTitleLocalizations Source: https://api.dashgo.com/index Schema definition for the AlbumTitleLocalizations object, handling localized titles for albums across various languages. ```APIDOC 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 } ``` -------------------------------- ### TrendsReport API Object Definition Source: https://api.dashgo.com/index Defines the structure for a trends report, including the DSP site, report date, and a presigned S3 download URL. ```APIDOC TrendsReport: object dsp_site: string report_date: date download_url: string Description: Presigned AWS S3 link that expires in 2 hours ``` -------------------------------- ### Album Artist Management API Endpoints Source: https://api.dashgo.com/index These API endpoints allow for the management of artists associated with a specific album. This includes adding new artists, retrieving a list of existing artists, and removing artists from an album. Roles for artists can also be specified. ```APIDOC DELETE /api/v2/albums/{album_id}/artists Description: Delete Artist from Album Parameters: - artist_id (int, formData): The ID of the artist to delete. - role (string, formData): Allowed roles are: any role from Contributor Roles + ["primary", "featuring"]. Responses: - 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 /api/v2/albums/{album_id}/artists Description: Returns list of album artists Parameters: - album_id (int, path): The ID of the album. Responses: - 200 OK: List all album artists (Returns AlbumArtists) - 401 Unauthorized: Authorization required - 403 Forbidden: Access to Album is forbidden - 404 Not Found: Album not found POST /api/v2/albums/{album_id}/artists Description: Add Artist to Album Parameters: - artist_id (int, formData): The ID of the artist to add. - role (string, formData): Allowed roles are: any role from Contributor Roles + ["primary", "featuring"]. Responses: - 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 ``` -------------------------------- ### API Object: BeatportGenresList Source: https://api.dashgo.com/index Schema definition for the BeatportGenresList object, providing Beatport genre identifiers. ```APIDOC BeatportGenresList: object genre_id: string ``` -------------------------------- ### Track Object Schema Source: https://api.dashgo.com/index Comprehensive schema for a track, including metadata such as IDs, copyright lines, composer, explicit status, ISRC, lyrics, and language. It also includes nested objects for file details. ```APIDOC Track: object id: int album_id: int artist_id: int c_line: string (YYYY Copyright) Track c line. composer: string cover_song: int Allowed Values: 0, 1 disc_number: int explicit: int Allowed Values: 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 Allowed Values: 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 ```