Component schema

GetTraceIdsRequest

object1 direct reference

Definition

Request to retrieve unique trace IDs of traces that contain at least one span matching the given filters. This is a lightweight alternative to GetSpans for two-step workflows where only trace IDs are needed first, and full trace details are subsequently retrieved via GetTrace (POST /api/trace/details).

FilterCriteria

TimeReferenceRangerequired

A range of time between two time references.

Dataset

Optional dataset to query across. Defaults to whatever is configured to be the default dataset for the organization.

Sampling

OrderingCriteria

The ordering criteria for the returned trace IDs. Only otel.trace.start_time descending is supported (this is also the default when omitted). Any other key, ascending direction, or multiple criteria will be rejected with a 400 response. A trace's start time is the timestamp of its earliest matching span; trace IDs are returned ordered by that value.

CursorPagination

Cursor pagination for trace IDs.

Maximum and default limit: 5000 elements per page
Multiple pages may be required to retrieve all matching trace IDs

Used by 1

These schemas and endpoints reference this type directly.

EndpointPOST /api/trace/ids

json

OpenAPI source12345678910111213141516171819202122232425262728
{
  "description": "Request to retrieve unique trace IDs of traces that contain at least one span matching the\ngiven filters. This is a lightweight alternative to `GetSpans` for two-step workflows where\nonly trace IDs are needed first, and full trace details are subsequently retrieved via\n`GetTrace` (`POST /api/trace/details`).\n",
  "properties": {
    "filter": {
      "$ref": "#/components/schemas/FilterCriteria"
    },
    "timeRange": {
      "$ref": "#/components/schemas/TimeReferenceRange"
    },
    "dataset": {
      "$ref": "#/components/schemas/Dataset"
    },
    "sampling": {
      "$ref": "#/components/schemas/Sampling"
    },
    "ordering": {
      "$ref": "#/components/schemas/OrderingCriteria",
      "description": "The ordering criteria for the returned trace IDs. Only `otel.trace.start_time` descending\nis supported (this is also the default when omitted). Any other key, ascending direction,\nor multiple criteria will be rejected with a 400 response. A trace's start time is the\ntimestamp of its earliest matching span; trace IDs are returned ordered by that value.\n"
    },
    "pagination": {
      "$ref": "#/components/schemas/CursorPagination",
      "description": "Cursor pagination for trace IDs.\n- Maximum and default limit: 5000 elements per page\n- Multiple pages may be required to retrieve all matching trace IDs\n"
    }
  },
  "required": [
    "timeRange"
  ]
}