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

    Type Alias GetLogEntriesData

    type GetLogEntriesData = {
        body?: never;
        path?: never;
        query?: {
            startIndex?: number;
            limit?: number;
            minDate?: string;
            maxDate?: string;
            hasUserId?: boolean;
            name?: string;
            overview?: string;
            shortOverview?: string;
            type?: string;
            itemId?: string;
            username?: string;
            severity?:
                | "Trace"
                | "Debug"
                | "Information"
                | "Warning"
                | "Error"
                | "Critical"
                | "None";
            sortBy?: ActivityLogSortBy[];
            sortOrder?: SortOrder[];
        };
        url: "/System/ActivityLog/Entries";
    }
    Index
    body? path? query? url

    Optionalbody

    body?: never
    path?: never
    query?: {
        startIndex?: number;
        limit?: number;
        minDate?: string;
        maxDate?: string;
        hasUserId?: boolean;
        name?: string;
        overview?: string;
        shortOverview?: string;
        type?: string;
        itemId?: string;
        username?: string;
        severity?:
            | "Trace"
            | "Debug"
            | "Information"
            | "Warning"
            | "Error"
            | "Critical"
            | "None";
        sortBy?: ActivityLogSortBy[];
        sortOrder?: SortOrder[];
    }

    Type Declaration

    • OptionalstartIndex?: number

      The record index to start at. All items with a lower index will be dropped from the results.

    • Optionallimit?: number

      The maximum number of records to return.

    • OptionalminDate?: string

      The minimum date.

    • OptionalmaxDate?: string

      The maximum date.

    • OptionalhasUserId?: boolean

      Filter log entries if it has user id, or not.

    • Optionalname?: string

      Filter by name.

    • Optionaloverview?: string

      Filter by overview.

    • OptionalshortOverview?: string

      Filter by short overview.

    • Optionaltype?: string

      Filter by type.

    • OptionalitemId?: string

      Filter by item id.

    • Optionalusername?: string

      Filter by username.

    • Optionalseverity?: "Trace" | "Debug" | "Information" | "Warning" | "Error" | "Critical" | "None"

      Filter by log severity.

    • OptionalsortBy?: ActivityLogSortBy[]

      Specify one or more sort orders. Format: SortBy=Name,Type.

    • OptionalsortOrder?: SortOrder[]

      Sort Order..

    url: "/System/ActivityLog/Entries"

    Settings
    Member Visibility

    On This Page
    Properties