Skip to main content
GET
JavaScript

Authorizations

x-api-key
string
header
required

Your unique Avido API key

x-application-id
string
header
required

Your unique Avido Application ID

Query Parameters

skip
integer
default:0

Number of items to skip before starting to collect the result set.

Required range: 0 <= x <= 9007199254740991
Example:

0

limit
integer

Number of items to include in the result set.

Required range: 1 <= x <= 100
Example:

25

orderBy
enum<string>
default:timestamp

Field to order the result set by.

Available options:
createdAt,
modifiedAt,
timestamp,
totalCost,
totalDurationMs,
stepCount,
id
Example:

"timestamp"

orderDir
enum<string>
default:desc

Order direction.

Available options:
asc,
desc
Example:

"desc"

testId
string<uuid>

Filter traces by test ID

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
Example:

"123e4567-e89b-12d3-a456-426614174000"

referenceId
string

Filter traces by reference ID

Example:

"ref-12345"

startDate
string<date-time>

Filter traces created after this date (inclusive).

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
Example:

"2024-01-01T00:00:00.000Z"

endDate
string<date-time>

Filter traces created before this date (inclusive).

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
Example:

"2024-12-31T23:59:59.999Z"

minCost
number

Filter traces with total cost greater than or equal to this value.

Required range: x >= 0
Example:

0.01

maxCost
number

Filter traces with total cost less than or equal to this value.

Required range: x >= 0
Example:

1

minDuration
integer

Filter traces with total duration (ms) greater than or equal to this value.

Required range: 0 <= x <= 2147483647
Example:

100

maxDuration
integer

Filter traces with total duration (ms) less than or equal to this value.

Required range: 0 <= x <= 2147483647
Example:

5000

hasError
boolean

Filter traces with or without errors.

Example:

true

metadataKey
string

Metadata key to filter on. Must be used together with metadataValue.

Example:

"userId"

metadataValue
string

Metadata value to filter on. Must be used together with metadataKey.

Example:

"user-123"

Full-text search across trace step content fields (input, output, toolInput, toolOutput, content, query, result).

Example:

"error in response"

minScore
number

Filter traces with eval score greater than or equal to this value.

Required range: 0 <= x <= 1
Example:

0.5

maxScore
number

Filter traces with eval score less than or equal to this value.

Required range: 0 <= x <= 1
Example:

0.9

Response

Successfully retrieved traces with steps

Paginated response containing traces

data
Trace · object[]
required
pagination
PaginationResponse · object
required

Pagination metadata returned in a paginated response.