Sign in

v1

latestOpenAPI 3.0.3Apache 2.02026-07-142201861.5 MB
Discover

Retrieve a Trace

Retrieve the spans, errors, and (optionally) uptime checks that make up a single trace.

The response is a list of top-level events; each item may have nested children, errors, and occurrences arrays representing related items. Top-level entries are spans by default and may also be uptime checks when include_uptime=1 is passed.

get/api/0/organizations/{organization_id_or_slug}/trace/{trace_id}/

Path parameters

organization_id_or_slugstring required

The ID or slug of the organization the resource belongs to.

trace_idstring required

The ID of the trace, a 32-character hexadecimal string.

Query parameters

statsPeriodstring

The period of time for the query, will override the start & end parameters, a number followed by one of:

  • d for days
  • h for hours
  • m for minutes
  • s for seconds
  • w for weeks

For example, 24h, to mean query data starting from 24 hours ago to now.

startstring date-time

The start of the period of time for the query, expected in ISO-8601 format. For example, 2001-12-14T12:34:56.7890.

endstring date-time

The end of the period of time for the query, expected in ISO-8601 format. For example, 2001-12-14T12:34:56.7890.

referrerstring

Internal referrer identifier used for query tracing. Most clients can omit this.

errorIdstring

A 32-character hexadecimal event ID to bias the trace results toward including.

additional_attributesstring[]

Additional span attributes to include on each event. Repeat to request multiple.

include_uptime'0' | '1'

Set to 1 to include uptime check results in the trace. Defaults to 0.

Response