Spans

spans

Methods

Create A Span ->
post/v5/spans

Create a single span and return the persisted span.

Use this for one-off span ingestion; to write many spans in one request use POST /v5/spans/batch. When id is omitted the server generates a UUID. Depending on per-account server configuration the span is persisted to Postgres, to the ClickHouse-backed tracing service, or both; when the tracing service is the primary store, a write failure returns a retryable 503 with a Retry-After header.

Get A Span ->
get/v5/spans/{span_id}

Retrieve a single span by its id.

The span is read from Postgres or, for accounts migrated to the ClickHouse-backed tracing service, from that service — with automatic fallback to Postgres on error unless the account is in strict mode, where a tracing-service failure surfaces as a 503. Access is authorized against the span's parent trace, so a span in a trace the caller cannot read is rejected; an unknown id returns 404.

Update A Span ->
patch/v5/spans/{span_id}

Partially update a span's mutable fields and return the updated span.

Only the provided fields among name, end timestamp, output, metadata, and status are changed. This endpoint is available only for accounts still backed solely by Postgres: once an account begins dual-writing to the ClickHouse-backed tracing service — which is upsert-only and has no partial-update operation — PATCH returns 501 and PUT /v5/spans/batch must be used instead. Updates are authorized against the span's parent trace, and an unknown id returns 404.

Create Spans In A Batch ->
post/v5/spans/batch

Create multiple spans (up to 1000) in a single request and return the created spans.

Prefer this over repeated POST /v5/spans calls when ingesting many spans at once; use PUT /v5/spans/batch instead when a span with the same id may already exist, since this endpoint inserts new spans rather than overwriting. A batch larger than 1000 spans is rejected with a validation error. Each item follows the same id-generation and per-account dual-write rules as the single-span create, and when the tracing service is the primary store a write failure returns a retryable 503.

Upsert Spans In A Batch ->
put/v5/spans/batch

Insert or replace multiple spans (up to 1000) in a single request, keyed by span id.

Use this for idempotent ingestion where a span with the same id may already exist — it will be overwritten — unlike POST /v5/spans/batch, which only inserts. Items without an id are assigned a generated UUID, and duplicate ids within the request are collapsed to the last occurrence. A batch larger than 1000 spans is rejected with a validation error. The write follows the same per-account dual-write rules, and when the tracing service is the primary store a write failure returns a retryable 503.

Search Spans -> CursorPage<>
post/v5/spans/search

Search and list spans matching a set of filters, returning a keyset-paginated page.

Filters in the request body include trace and span ids, names, statuses, types, free-text search, metadata, duration bounds, and more, scoped to an optional time window. Results are keyset-paginated on indexed columns rather than offset-paginated, and total is not computed (it is always 0); use the pagination cursors to page through results. Reads route to Postgres or the ClickHouse-backed tracing service per account (with Postgres fallback outside strict mode), and results are narrowed to traces the caller is authorized to read — a filter that resolves to no authorized traces yields an empty page rather than an error.

query Parameters
ending_before: string
Optional
from_ts: string
Optional
(format: date-time)

The starting (oldest) timestamp in ISO format.

limit: number
Optional
(maximum: 10000, minimum: 1, default: 100)
sort_by: string
Optional
sort_order:
Optional
starting_after: string
Optional
to_ts: string
Optional
(format: date-time)

The ending (most recent) timestamp in ISO format.

Response fields
has_more: boolean

Whether there are more items left to be fetched.

items: Array<>
total: number

The total of items that match the query. This is greater than or equal to the number of items returned.

limit: number
Optional
(default: 100)

The maximum number of items to return.

object: "list"
Optional
(default: "list")
Request example
200Example

Domain types

APIListSpan = { items, object }
Span = { id, account_id, name, 15 more... }
SpanBatchCreate = { items }
SpanCreate = { name, start_timestamp, trace_id, 12 more... }
SpanStatus = "SUCCESS" | "ERROR" | "CANCELED"
SpanType = "TEXT_INPUT" | "TEXT_OUTPUT" | "COMPLETION_INPUT" | 23 more...