@videosdk.live/server-sdk
    Preparing search index...

    Interface ListSessionsParams

    Query parameters for SessionsResource.list.

    interface ListSessionsParams {
        cursor?: string;
        customRoomId?: string;
        endDate?: number;
        page?: number;
        perPage?: number;
        query?: string;
        roomId?: string;
        startDate?: number;
        status?: "ongoing" | "ended";
    }

    Hierarchy (View Summary)

    Index
    cursor? customRoomId? endDate? page? perPage? query? roomId? startDate? status?
    cursor?: string

    Opaque cursor from a previous Page.nextCursor. Overrides page/perPage.

    customRoomId?: string

    Filter by custom room id.

    endDate?: number

    Epoch milliseconds — end of range.

    Optionalpage

    page?: number

    1-based page number. Defaults server-side to 1.

    perPage?: number

    Items per page. Server default is 10 or 20 depending on the resource.

    query?: string

    Exact match on the room's roomId/customRoomId.

    roomId?: string

    Filter by room id.

    startDate?: number

    Epoch milliseconds — start of range (applied to session start).

    status?: "ongoing" | "ended"

    Filter by lifecycle state: "ongoing" or "ended".

    Settings
    Member Visibility

    On This Page
    Properties