Search spans with simple filters (no DSL)

Return spans within a project filtered by time range. Supports cursor-based pagination.

GET /v1/projects/{project_identifier}/spans/otlpv1

Try it

Search spans with simple filters (no DSL)

cURL

curl --request GET \
  --url https://api.example.com/v1/projects/{project_identifier}/spans/otlpv1

200

{
  "data": [
    {
      "attributes": [
        {
          "key": "<string>",
          "value": {
            "array_value": {
              "values": [
                "<unknown>"
              ]
            },
            "bool_value": true,
            "bytes_value": "<string>",
            "double_value": 123,
            "int_value": 0,
            "kvlist_value": "<unknown>",
            "string_value": "<string>"
          }
        }
      ],
      "dropped_attributes_count": 2147483647,
      "dropped_events_count": 2147483647,
      "dropped_links_count": 2147483647,
      "end_time_unix_nano": 9223372036854776000,
      "events": [
        {
          "attributes": [
            {
              "key": "<string>",
              "value": {
                "array_value": {
                  "values": [
                    "<unknown>"
                  ]
                },
                "bool_value": true,
                "bytes_value": "<string>",
                "double_value": 123,
                "int_value": 0,
                "kvlist_value": "<unknown>",
                "string_value": "<string>"
              }
            }
          ],
          "dropped_attributes_count": 2147483647,
          "name": "<string>",
          "time_unix_nano": 9223372036854776000
        }
      ],
      "flags": 2147483647,
      "kind": "SPAN_KIND_INTERNAL",
      "links": "<unknown>",
      "name": "<string>",
      "parent_span_id": "<string>",
      "span_id": "<string>",
      "start_time_unix_nano": 9223372036854776000,
      "status": {
        "code": -1,
        "message": "<string>"
      },
      "trace_id": "<string>",
      "trace_state": "<string>"
    }
  ],
  "next_cursor": "<string>"
}

Path Parameters

project_identifier · string · required

The project identifier: either project ID or project name. If using a project name, it cannot contain slash (/), question mark (?), or pound sign (#) characters.

Query Parameters

cursor · string | null

Pagination cursor (Span Global ID)

limit · integer · default: 100

Maximum number of spans to return

Required range: x <= 1000

start_time · string<date-time> | null

Inclusive lower bound time

end_time · string<date-time> | null

Exclusive upper bound time

Response

200

application/json

Successful Response

Paginated response where each span follows OTLP JSON structure.

data · OtlpSpan · object[] · required

Show child attributes

data. attributes · OtlpKeyValue · object[] | null

attributes is a collection of key/value pairs. Note, global attributes like server name can be set using the resource API. Examples of attributes:

"/http/user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_2) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/71.0.3578.98 Safari/537.36"
"/http/server_latency": 300
"example.com/myattribute": true
"example.com/score": 10.239

The OpenTelemetry API specification further restricts the allowed value types: https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/common/README.md#attribute Attribute keys MUST be unique (it is not allowed to have more than one attribute with the same key).

Show child attributes

data.attributes. key · string | null

data.attributes. value · OtlpAnyValue · object

Show child attributes

data.attributes.value. array_value · OtlpArrayValue · object

Show child attributes

data.attributes.value.array_value. values · any[] | null

Array of values. The array may be empty (contain 0 elements).

data.attributes.value. bool_value · boolean | null

data.attributes.value. bytes_value · string | null

data.attributes.value. double_value

data.attributes.value. int_value

Required range: -9223372036854776000 <= x < 9223372036854776000

data.attributes.value. kvlist_value · null

data.attributes.value. string_value · string | null

data. dropped_attributes_count · integer | null

dropped_attributes_count is the number of attributes that were discarded. Attributes can be discarded because their keys are too long or because there are too many attributes. If this value is 0, then no attributes were dropped.

Required range: 0 <= x <= 4294967295

data. dropped_events_count · integer | null

dropped_events_count is the number of dropped events. If the value is 0, then no events were dropped.

Required range: 0 <= x <= 4294967295

data. dropped_links_count · integer | null

dropped_links_count is the number of dropped links after the maximum size was enforced. If this value is 0, then no links were dropped.

Required range: 0 <= x <= 4294967295

data. end_time_unix_nano

end_time_unix_nano is the end time of the span. On the client side, this is the time kept by the local machine where the span execution ends. On the server side, this is the time when the server application handler stops running. Value is UNIX Epoch time in nanoseconds since 00:00:00 UTC on 1 January 1970.

This field is semantically required and it is expected that end_time >= start_time.

Required range: 0 <= x < 18446744073709552000

data. events · OtlpEvent · object[] | null

events is a collection of Event items. A span with no events is valid.

Show child attributes

data.events. attributes · OtlpKeyValue · object[] | null

attributes is a collection of attribute key/value pairs on the event. Attribute keys MUST be unique (it is not allowed to have more than one attribute with the same key).

Show child attributes

data.events.attributes. key · string | null

data.events.attributes. value · OtlpAnyValue · object

Show child attributes

data.events.attributes.value. array_value · OtlpArrayValue · object

Show child attributes

data.events.attributes.value.array_value. values · any[] | null

Array of values. The array may be empty (contain 0 elements).

data.events.attributes.value. bool_value · boolean | null

data.events.attributes.value. bytes_value · string | null

data.events.attributes.value. double_value

data.events.attributes.value. int_value

Required range: -9223372036854776000 <= x < 9223372036854776000

data.events.attributes.value. kvlist_value · null

data.events.attributes.value. string_value · string | null

data.events. dropped_attributes_count · integer | null

dropped_attributes_count is the number of dropped attributes. If the value is 0, then no attributes were dropped.

Required range: 0 <= x <= 4294967295

data.events. name · string | null

name of the event. This field is semantically required to be set to non-empty string.

data.events. time_unix_nano

time_unix_nano is the time the event occurred. Value is UNIX Epoch time in nanoseconds since 00:00:00 UTC on 1 January 1970.

Required range: 0 <= x < 18446744073709552000

data. flags · integer | null

Flags, a bit field.

Bits 0-7 (8 least significant bits) are the trace flags as defined in W3C Trace Context specification. To read the 8-bit W3C trace flag, use flags & SPAN_FLAGS_TRACE_FLAGS_MASK.

See https://www.w3.org/TR/trace-context-2/#trace-flags for the flag definitions.

Bits 8 and 9 represent the 3 states of whether a span's parent is remote. The states are (unknown, is not remote, is remote). To read whether the value is known, use (flags & SPAN_FLAGS_CONTEXT_HAS_IS_REMOTE_MASK) != 0. To read whether the span is remote, use (flags & SPAN_FLAGS_CONTEXT_IS_REMOTE_MASK) != 0.

When creating span messages, if the message is logically forwarded from another source with an equivalent flags fields (i.e., usually another OTLP span message), the field SHOULD be copied as-is. If creating from a source that does not have an equivalent flags field (such as a runtime representation of an OpenTelemetry span), the high 22 bits MUST be set to zero. Readers MUST NOT assume that bits 10-31 (22 most significant bits) will be zero.

[Optional].

Required range: 0 <= x <= 4294967295

data. kind · default: SPAN_KIND_INTERNAL

Distinguishes between spans generated in a particular context. For example, two spans with the same name may be distinguished using CLIENT (caller) and SERVER (callee) to identify queueing latency associated with the span.

Available options: SPAN_KIND_UNSPECIFIED, SPAN_KIND_INTERNAL, SPAN_KIND_SERVER, SPAN_KIND_CLIENT, SPAN_KIND_PRODUCER, SPAN_KIND_CONSUMER

data. links · null

data. name · string | null

A description of the span's operation.

For example, the name can be a qualified method name or a file name and a line number where the operation is called. A best practice is to use the same display name at the same call point in an application. This makes it easier to correlate spans in different traces.

This field is semantically required to be set to non-empty string. Empty value is equivalent to an unknown span name.

This field is required.

data. parent_span_id · string | null

The span_id of this span's parent span. If this is a root span, then this field must be empty. The ID is an 8-byte array.

data. span_id · string | null

A unique identifier for a span within a trace, assigned when the span is created. The ID is an 8-byte array. An ID with all zeroes OR of length other than 8 bytes is considered invalid (empty string in OTLP/JSON is zero-length and thus is also invalid).

This field is required.

data. start_time_unix_nano

start_time_unix_nano is the start time of the span. On the client side, this is the time kept by the local machine where the span execution starts. On the server side, this is the time when the server's application handler starts running. Value is UNIX Epoch time in nanoseconds since 00:00:00 UTC on 1 January 1970.

This field is semantically required and it is expected that end_time >= start_time.

Required range: 0 <= x < 18446744073709552000

data. status · OtlpStatus · object

An optional final status for this span. Semantically when Status isn't set, it means span's status code is unset, i.e. assume STATUS_CODE_UNSET (code = 0).

Show child attributes

data.status. code · integer | null

The status code.

Required range: -2147483648 <= x <= 2147483647

data.status. message · string | null

A developer-facing human readable error message.

data. trace_id · string | null

A unique identifier for a trace. All spans from the same trace share the same trace_id. The ID is a 16-byte array. An ID with all zeroes OR of length other than 16 bytes is considered invalid (empty string in OTLP/JSON is zero-length and thus is also invalid).

This field is required.

data. trace_state · string | null

trace_state conveys information about request position in multiple distributed tracing graphs. It is a trace_state in w3c-trace-context format: https://www.w3.org/TR/trace-context/#tracestate-header See also https://github.com/w3c/distributed-tracing for more details about this field.

next_cursor · string | null · required