Tsarr Documentation - v2.16.0
    Preparing search index...

    Type Alias GetSimilarItemsData

    type GetSimilarItemsData = {
        body?: never;
        path: { itemId: string };
        query?: {
            excludeArtistIds?: string[];
            userId?: string;
            limit?: number;
            fields?: ItemFields[];
        };
        url: "/Items/{itemId}/Similar";
    }
    Index
    body? path query? url

    Optionalbody

    body?: never
    path: { itemId: string }

    Type Declaration

    • itemId: string

      The item id.

    query?: {
        excludeArtistIds?: string[];
        userId?: string;
        limit?: number;
        fields?: ItemFields[];
    }

    Type Declaration

    • OptionalexcludeArtistIds?: string[]

      Exclude artist ids.

    • OptionaluserId?: string

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

    • Optionallimit?: number

      Optional. The maximum number of records to return.

    • Optionalfields?: ItemFields[]

      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.

    url: "/Items/{itemId}/Similar"

    Settings
    Member Visibility

    On This Page
    Properties