Component schema

GetSpansRequest

object1 direct reference

Definition

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 spans. Supported ordering key: otel.span.start_time (span start timestamp, defaults to descending)

CursorPagination

Cursor pagination for spans.

Maximum and default limit: 200 elements per page
We do not guarantee that the requested number of elements will be returned per page
Multiple pages may be required to retrieve the requested number of signals

Used by 1

These schemas and endpoints reference this type directly.

EndpointPOST /api/spans

json

OpenAPI source123456789101112131415161718192021222324252627
{
  "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 spans.\nSupported ordering key: `otel.span.start_time` (span start timestamp, defaults to descending)\n"
    },
    "pagination": {
      "$ref": "#/components/schemas/CursorPagination",
      "description": "Cursor pagination for spans.\n- Maximum and default limit: 200 elements per page\n- We do not guarantee that the requested number of elements will be returned per page\n- Multiple pages may be required to retrieve the requested number of signals\n"
    }
  },
  "required": [
    "timeRange"
  ]
}