Langfuse JS/TS SDKs
    Preparing search index...

    Interface GetScoresV3Request

    {}
    interface GetScoresV3Request {
        authorUserId?: string;
        configId?: string;
        cursor?: string;
        dataType?: string;
        environment?: string;
        experimentId?: string;
        fields?: string;
        fromTimestamp?: string;
        id?: string;
        limit?: number;
        name?: string;
        observationId?: string;
        queueId?: string;
        sessionId?: string;
        source?: string;
        toTimestamp?: string;
        traceId?: string;
        value?: string;
        valueMax?: number;
        valueMin?: number;
    }
    Index

    Properties

    authorUserId? configId? cursor? dataType? environment? experimentId? fields? fromTimestamp? id? limit? name? observationId? queueId? sessionId? source? toTimestamp? traceId? value? valueMax? valueMin?

    Properties

    authorUserId?: string

    Comma-separated list of author user IDs to filter by.

    configId?: string

    Comma-separated list of score config IDs to filter by.

    cursor?: string

    URL-safe base64 (base64url) cursor for pagination. Use the cursor from the previous response to get the next page. Absent on the final page.

    dataType?: string

    Comma-separated list of data types to filter by (NUMERIC, BOOLEAN, CATEGORICAL, TEXT, CORRECTION). Case-insensitive — numeric and NUMERIC are equivalent. Must be a single value when used with value, valueMin, or valueMax; otherwise the request returns HTTP 400. Must be NUMERIC when used with valueMin or valueMax.

    environment?: string

    Comma-separated list of environments to filter by.

    experimentId?: string

    Comma-separated list of dataset run IDs (experiment IDs) to filter by. Mutually exclusive with traceId, sessionId, observationId.

    fields?: string

    Comma-separated field groups to include in addition to the always-returned core fields. Allowed: details, subject, annotation — see the endpoint description for the fields each group adds. Unknown names return HTTP 400.

    fromTimestamp?: string

    Inclusive lower bound on the score timestamp.

    id?: string

    Comma-separated list of score IDs to filter by (OR within, AND across filters).

    limit?: number

    Number of items per page. Maximum 100, default 50. Requests with a limit greater than 100 return HTTP 400.

    name?: string

    Comma-separated list of score names to filter by.

    observationId?: string

    Comma-separated list of observation IDs to filter by. Requires traceId to be specified, because observation IDs are scoped to a trace. Mutually exclusive with sessionId, experimentId. Returns HTTP 400 when used without traceId.

    queueId?: string

    Comma-separated list of annotation queue IDs to filter by.

    sessionId?: string

    Comma-separated list of session IDs to filter by. Mutually exclusive with traceId, observationId, experimentId.

    source?: string

    Comma-separated list of score sources to filter by (e.g. API, ANNOTATION, EVAL). Case-insensitive — api and API are equivalent.

    toTimestamp?: string

    Exclusive upper bound on the score timestamp.

    traceId?: string

    Comma-separated list of trace IDs to filter by. Mutually exclusive with sessionId, experimentId. May be combined with observationId to scope the observation lookup to a specific trace.

    value?: string

    Comma-separated list of exact values to filter by. Requires a single dataType from NUMERIC, BOOLEAN, or CATEGORICAL; any other dataType, multiple dataTypes, or omitting dataType returns HTTP 400. For BOOLEAN, each value must be "true" or "false"; for NUMERIC, each value must be a finite number. Otherwise the request returns HTTP 400.

    valueMax?: number

    Inclusive upper bound on the numeric value. Requires dataType=NUMERIC as a single value; otherwise the request returns HTTP 400.

    valueMin?: number

    Inclusive lower bound on the numeric value. Requires dataType=NUMERIC as a single value; otherwise the request returns HTTP 400.

    Settings

    Member Visibility

    On This Page

    Properties