Component schema

GetSpansResponse

object1 direct reference

Definition

Response for the GetSpans API. The response contains the spans that match the request.

This API deliberately reuses the full OTLP JSON format for spans. This is done to aid compatibility with existing OTLP consumers.

FixedTime

The property is only included when includeOTLPSchemaExtensions is true.

TimeRange

The property is only included when includeOTLPSchemaExtensions is true.

NextCursors

The cursors for the next sets of results. This property is included to support pagination through the result set when additional pages are available.

ResourceSpans[]required

There is one ResourceSpan per resource. This is aligned to the data most OTLP batching algorithms would produce, where there is one ResourceSpan per resource. This is done to aid compatibility with existing OTLP consumers.

Spans nested in ResourceSpans are ONLY sorted if an explicit ordering has been defined. However, it is guaranteed that all data is sorted across paged requests.

Used by 1

These schemas and endpoints reference this type directly.

EndpointPOST /api/spans

json

OpenAPI source123456789101112131415161718192021222324252627
{
  "description": "Response for the `GetSpans` API. The response contains the spans that match the request.\n\nThis API deliberately reuses the full OTLP JSON format for spans. This is done to aid compatibility\nwith existing OTLP consumers.\n",
  "properties": {
    "executionTime": {
      "$ref": "#/components/schemas/FixedTime",
      "description": "The property is only included when `includeOTLPSchemaExtensions` is `true`."
    },
    "timeRange": {
      "$ref": "#/components/schemas/TimeRange",
      "description": "The property is only included when `includeOTLPSchemaExtensions` is `true`."
    },
    "cursors": {
      "$ref": "#/components/schemas/NextCursors",
      "description": "The cursors for the next sets of results. This property is included\nto support pagination through the result set when additional pages are available.\n"
    },
    "resourceSpans": {
      "description": "There is one `ResourceSpan` per resource. This is aligned to the data most OTLP batching algorithms would\nproduce, where there is one `ResourceSpan` per resource. This is done to aid compatibility with existing\nOTLP consumers.\n\n`Spans` nested in `ResourceSpans` are **ONLY** sorted if an explicit ordering has been defined. However,\nit is guaranteed that all data is sorted across paged requests.\n",
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/ResourceSpans"
      }
    }
  },
  "required": [
    "resourceSpans"
  ]
}