Skip to main content
GET
/
v0
/
traces
List Traces
curl --request GET \
  --url https://api.avidoai.com/v0/traces \
  --header 'x-api-key: <api-key>' \
  --header 'x-application-id: <api-key>'
{
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "timestamp": "2025-01-05T12:34:56.789123Z",
      "referenceId": "123e4567-e89b-12d3-a456-426614174000",
      "metadata": {
        "userId": "123",
        "source": "chatbot"
      },
      "testId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "steps": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "traceId": "610adba1-7cc0-4fa7-9e2b-8bd2fdf281b2",
          "timestamp": "2025-01-05T12:34:56.789123Z",
          "type": "<string>",
          "modelId": "gpt-4o-2024-08-06",
          "event": "<string>",
          "input": "Tell me a joke.",
          "name": "Moderation",
          "group": "inputModeration",
          "params": {},
          "metadata": {}
        }
      ]
    }
  ],
  "pagination": {
    "skip": 0,
    "limit": 25,
    "total": 100,
    "totalPages": 4
  }
}

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
string
default:createdAt

Field to order by in the result set.

Example:

"createdAt"

​
orderDir
enum<string>
default:desc

Order direction.

Available options:
asc,
desc
Example:

"desc"

​
testId
string<uuid>

Filter traces by test ID

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).

Example:

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

​
endDate
string<date-time>

Filter traces created before this date (inclusive).

Example:

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

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.