Export (0) Print
Expand All

orderBy parameter for Catalog and Collection Browse APIs

The Catalog Browse and Collection Browse APIs offer an optional query parameter orderBy that allows ordering the results in a specific order.

When you don't specify a value for orderBy, we choose the default value depending on what type of content you are browsing.

If you specify an invalid value for a specific content, we will issue an HTTP 400 Bad Request error (for example, ordering Artists by ReleaseDate makes no sense).

Possible values in the Collection Browse API

Item typeorderBy valueDescription
ArtistArtistNameDefault. The artist's name, sorted alphabetically.
CollectionDateDate when the artist was added to the collection, most recent first.
AlbumAlbumTitleDefault. The album's title, sorted alphabetically.
ArtistNameName of the main artist of the album, sorted alphabetically.
GenreNameGenre of the album, sorted alphabetically.
ReleaseDateRelease date of the album, most recent first.
CollectionDateDate when the album was added to the collection, most recent first
PlaylistCollectionDateDefault. Date when the playlist was created, most recent first
TrackActionResultTrackTitleDefault. The track's title, sorted alphabetically
AlbumTitleTitle of the album containing the track, sorted alphabetically.
ArtistNameName of the main artist of the track, sorted alphabetically
GenreNameGenre of the track, sorted alphabetically
ReleaseDateRelease date of the track, most recent first
CollectionDateDate when the track was added to the collection, most recent first
TrackNumberTrack number

Possible values in the Catalog Browse API

Item typeorderBy valueDescription
Artist, Album, or TrackAllTimePlayCountThe number of times the item has been played.
ReleaseDateDefault. Release date.
MostPopularPopularity.

Community Additions

ADD
Show:
© 2014 Microsoft