@playlive/fundraiser-data
    Preparing search index...

    Interface FetchLeaderboardWithExclusionsParams

    Params for fetchLeaderboardWithExclusions.

    interface FetchLeaderboardWithExclusionsParams {
        campaignID: string;
        count?: number;
        endDate?: string | Date;
        isTeam?: boolean;
        signal?: AbortSignal;
        startDate?: string | Date;
        timeType?: "daily" | "weekly" | "monthly" | "yearly" | "ytd" | "all";
    }
    Index
    campaignID count? endDate? isTeam? signal? startDate? timeType?
    campaignID: string
    count?: number

    Max entries to return. Defaults to the service default (100).

    endDate?: string | Date

    Inclusive ISO 8601 upper bound. See startDate.

    isTeam?: boolean

    Set to true when campaignID is a Tiltify team campaign UUID.

    signal?: AbortSignal

    Cancel on React unmount / other lifecycle events.

    startDate?: string | Date

    Inclusive ISO 8601 lower bound. Presence of startDate or endDate switches the service to the SQL-aggregation path (bypasses Tiltify's leaderboard endpoint).

    timeType?: "daily" | "weekly" | "monthly" | "yearly" | "ytd" | "all"

    Fixed calendar bucket. Ignored when either startDate or endDate is supplied — the service switches to an ad-hoc window aggregation on the date-range path.

    Settings
    Member Visibility

    On This Page
    Properties