Interface ApiScoreGetParams

interface ApiScoreGetParams {
    configId?: null | string;
    dataType?: null | ApiScoreDataType;
    fromTimestamp?: null | string;
    limit?: null | number;
    name?: null | string;
    operator?: null | string;
    page?: null | number;
    queueId?: null | string;
    scoreIds?: null | string;
    source?: null | ApiScoreSource;
    toTimestamp?: null | string;
    traceTags?: (null | string)[];
    userId?: null | string;
    value?: null | number;
}

Properties

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

Properties

OptionalconfigId

configId?: null | string

Retrieve only scores with a specific configId.

OptionaldataType

dataType?: null | ApiScoreDataType

Retrieve only scores with a specific dataType.

OptionalfromTimestamp

fromTimestamp?: null | string

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

Format

date-time

Optionallimit

limit?: null | number

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

Optionalname

name?: null | string

Retrieve only scores with this name.

Optionaloperator

operator?: null | string

Retrieve only scores with value.

Optionalpage

page?: null | number

Page number, starts at 1.

OptionalqueueId

queueId?: null | string

Retrieve only scores with a specific annotation queueId.

OptionalscoreIds

scoreIds?: null | string

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

Optionalsource

source?: null | ApiScoreSource

Retrieve only scores from a specific source.

OptionaltoTimestamp

toTimestamp?: null | string

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

Format

date-time

OptionaltraceTags

traceTags?: (null | string)[]

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

OptionaluserId

userId?: null | string

Retrieve only scores with this userId associated to the trace.

Optionalvalue

value?: null | number

Retrieve only scores with value.

Format

double

Settings

Member Visibility

On This Page

Properties