Get list of traces

Endpoint to create a new dataset on toolzz analytics

GET /api/trpc/traces.all

Get list of traces

cURL

curl --request GET \
  --url https://analytics.toolzz.ai/api/trpc/traces.all

200

{
  "data": [
    {
      "id": "<string>",
      "timestamp": "<string>",
      "name": "<string>",
      "input": null,
      "output": null,
      "sessionId": "<string>",
      "release": "<string>",
      "version": "<string>",
      "userId": "<string>",
      "metadata": null,
      "tags": [
        {}
      ],
      "public": true,
      "htmlPath": "<string>",
      "latency": 123,
      "totalCost": 123,
      "observations": [
        {
          "observationId": "<string>"
        }
      ],
      "scores": [
        {
          "scoreId": "<string>"
        }
      ]
    }
  ],
  "meta": {
    "page": 123,
    "limit": 123,
    "totalItems": 123,
    "totalPages": 123
  }
}

Show Request

page · integer

Page number, starts at 1 (optional).

limit · integer

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

userId · string

Optional filter for a specific user ID.

name · string

Optional filter for a specific name.

sessionId · string

Optional filter for a specific session ID.

fromTimestamp · date-time

Optional filter to include traces with a timestamp on or after a certain datetime (ISO 8601).

toTimestamp · date-time

Optional filter to include traces with a timestamp before a certain datetime (ISO 8601).

orderBy · string

Format of the string [field].[asc/desc]. Fields: id, timestamp, name, userId, release, version, etc. (optional).

tags · array

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

version · string

Optional filter to include traces with a certain version.

release · string

Optional filter to include traces with a certain release.

Response Description

Below you will see the description of the create dataset response

data · array · required

List of trace records.

Show properties

id · string · required

Unique identifier for the trace record.

timestamp · Date · required

Timestamp indicating when the trace was recorded.

name · string · required

Name of the trace record.

input · null

Input data associated with the trace.

output · null

Output data associated with the trace.

sessionId · string · required

Identifier for the session associated with the trace.

release · string · required

Release version associated with the trace.

version · string · required

Version of the trace.

userId · string · required

Identifier for the user associated with the trace.

metadata · null

Metadata associated with the trace.

tags · array · required

List of tags associated with the trace.

public · boolean · required

Indicates if the trace is public.

htmlPath · string

Path to the HTML representation of the trace (optional).

latency · integer · required

Latency of the trace process in milliseconds.

totalCost · integer · required

Total cost associated with the trace.

observations · array · required

List of observation IDs associated with the trace.

Show items

observationId · string · required

Unique identifier for an observation.

scores · array · required

List of score IDs associated with the trace.

Show items

scoreId · string · required

Unique identifier for a score.

meta · object · required

Pagination metadata.

Show properties

page · integer · required

Current page number.

limit · integer · required

Maximum number of items per page.

totalItems · integer · required

Total number of items available.

totalPages · integer · required

Total number of pages available.

Code Response

Exemples of Response Code

200

Request Successful Response

400

Request Failure