Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Jaeger Traces API

Endpoints for searching and retrieving distributed traces.

Jaeger Traces API is one of 7 APIs that Jaeger publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Traces. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a GitHub repository, and a changelog.

This API exposes 2 operations across 2 paths, and defines 7 schemas. It is described by OpenAPI 3.0.3, at version 1.0.0.

Requests are made against a single base URL, http://localhost:16686.

2 operations 2 paths 7 schemas 2 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0.0
Server
http://localhost:16686
License
Resource Areas
1

Paths & Operations 2

Across 2 paths, the API surfaces 2 operations — 2 GET. Each is listed below with its method, path, parameters, and response codes.

Traces 2

Endpoints for searching and retrieving distributed traces.

GET
/api/traces
Search traces
searchTraces 9 params → 200400500
GET
/api/traces/{traceID}
Get a trace by ID
getTrace 3 params → 200404500

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are Span (11 properties), Trace (4 properties), StructuredError (3 properties), SpanReference (3 properties). Each schema is shown below with its type and property counts.

SpanLog
object
A time-stamped log entry within a span.
2 properties 2 required
KeyValue
object
A typed key-value pair used for span tags and log fields.
3 properties 3 required
Span
object
A span represents a single unit of work within a trace. Spans have a start time, duration, and contain metadata about the operation being performed.
11 properties 5 required
Process
object
A process represents the service instance that produced spans.
2 properties 1 required
SpanReference
object
A reference from one span to another, establishing causal relationships within a trace.
3 properties 3 required
Trace
object
A trace represents the complete journey of a request through a distributed system. It consists of one or more spans forming a directed acyclic graph.
4 properties 3 required
StructuredError
object
A structured error returned by the API.
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

jaeger-traces-api-openapi.yml Raw ↑

Other APIs Jaeger publishes across the network.

Jaeger Collector API
Jaeger Remote Storage API
Jaeger Remote Sampling API
Jaeger Dependencies API
Jaeger Metrics API
Jaeger Services API