Skip to main content

advancedSearch

This feature is in public preview. The API might change at any time.

advancedSearch(
trackID: ID = 0
trackIDs: [ID!] = []
text: String
target: AdvancedSearchTarget!
metadataFilter: JSONObject
searchMode: SimilarTracksSearchMode
retrieveSegmentScores: Boolean
first: Int = 10
): AdvancedSearchResult!

Arguments​

trackID (ID)​

Track ID to perform the advanced search. Use spotify ID or library track ID.

trackIDs ([ID!])​

List of track IDs to perform the advanced search. Use spotify IDs or library track IDs. Maximum is 50 tracks. More are omitted.

text (String)​

Text to search for. This is a free text search. Maximum character is 1024. More are omitted.

target (AdvancedSearchTarget!)​

Target for the advanced search: library, crate or spotify

metadataFilter (JSONObject)​

Advanced search metadata filter that contains custom flexibly search criterias for tracks. A detailed documentation can be found under: Metadata Filter.

searchMode (SimilarTracksSearchMode)​

The relevant parts of the track that should be used for the advanced search. This is only available when a single trackID is specified.

retrieveSegmentScores (Boolean)​

Option to retrieve segment scores for the top scoring segments. You need to set this if you query for topScoringSegments.

first (Int)​

Amount of tracks to retrieve. Maximum is 500 tracks. If used with retrieveSegmentScores the maximum is 30 tracks.

Type​

AdvancedSearchResult​