Langfuse JS/TS SDKs
    Preparing search index...

    Interface GetScoresRequest

    {}
    interface GetScoresRequest {
        configId?: string;
        dataType?: ScoreDataType;
        environment?: string | string[];
        fromTimestamp?: string;
        limit?: number;
        name?: string;
        operator?: string;
        page?: number;
        queueId?: string;
        scoreIds?: string;
        sessionId?: string;
        source?: ScoreSource;
        toTimestamp?: string;
        traceTags?: string | string[];
        userId?: string;
        value?: number;
    }
    Index

    Properties

    configId? dataType? environment? fromTimestamp? limit? name? operator? page? queueId? scoreIds? sessionId? source? toTimestamp? traceTags? userId? value?

    Properties

    configId?: string

    Retrieve only scores with a specific configId.

    dataType?: ScoreDataType

    Retrieve only scores with a specific dataType.

    environment?: string | string[]

    Optional filter for scores where the environment is one of the provided values.

    fromTimestamp?: string

    Optional filter to only include scores created on or after a certain datetime (ISO 8601)

    limit?: number

    Limit of items per page. If you encounter api issues due to too large page sizes, try to reduce the limit.

    name?: string

    Retrieve only scores with this name.

    operator?: string

    Retrieve only scores with value.

    Optionalpage

    page?: number

    Page number, starts at 1.

    queueId?: string

    Retrieve only scores with a specific annotation queueId.

    scoreIds?: string

    Comma-separated list of score IDs to limit the results to.

    sessionId?: string

    Retrieve only scores with a specific sessionId.

    source?: ScoreSource

    Retrieve only scores from a specific source.

    toTimestamp?: string

    Optional filter to only include scores created before a certain datetime (ISO 8601)

    traceTags?: string | string[]

    Only scores linked to traces that include all of these tags will be returned.

    userId?: string

    Retrieve only scores with this userId associated to the trace.

    value?: number

    Retrieve only scores with value.

    Settings

    Member Visibility

    On This Page

    Properties