v1

latestOpenAPI 3.0.12026-07-134082641.7 MB
Library

Gets similar items.

get/Albums/{itemId}/Similar

Path parameters

itemIdstring uuid required

The item id.

The item id.

Query parameters

excludeArtistIdsstring[] nullable

Exclude artist ids.

Exclude artist ids.

userIdstring uuid nullable

Optional. Filter by user id, and attach user data.

Optional. Filter by user id, and attach user data.

limitinteger nullable

Optional. The maximum number of records to return.

Optional. The maximum number of records to return.

fieldsItemFields[] nullable

Optional. Specify additional fields of information to return in the output. This allows multiple, comma delimited. Options: Budget, Chapters, DateCreated, Genres, HomePageUrl, IndexOptions, MediaStreams, Overview, ParentId, Path, People, ProviderIds, PrimaryImageAspectRatio, Revenue, SortName, Studios, Taglines, TrailerUrls.

Optional. Specify additional fields of information to return in the output. This allows multiple, comma delimited. Options: Budget, Chapters, DateCreated, Genres, HomePageUrl, IndexOptions, MediaStreams, Overview, ParentId, Path, People, ProviderIds, PrimaryImageAspectRatio, Revenue, SortName, Studios, Taglines, TrailerUrls.

Response

Similar items returned.

TotalRecordCountinteger

The total number of records available.

StartIndexinteger

The index of the first record in Items.