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 QueryService API

The QueryService API from Jaeger — 6 operation(s) for queryservice.

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

This API exposes 2 JSON Schema definitions.

Tagged areas include QueryService. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, and 2 JSON Schemas.

This API exposes 8 operations across 6 paths, and defines 26 schemas. It is described by OpenAPI 3.0.3, at version 2.0.

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

8 operations 6 paths 26 schemas 6 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
2.0
Server
http://localhost:14268
License
Resource Areas
1

Paths & Operations 8

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

QueryService 8
GET
/api/v3/dependencies
QueryService_GetDependencies 2 params → 200default
GET
/api/v3/operations
GetOperations returns operation names.
QueryService_GetOperations 2 params → 200default
GET
/api/v3/services
GetServices returns service names.
QueryService_GetServices → 200default
GET
/api/v3/trace-summaries
FindTraceSummaries searches for traces matching the given query and streams back lightweight summary information for each matching trace. Each response chunk may contain one or more summaries. Use th…
QueryService_FindTraceSummaries 8 params → 200default
POST
/api/v3/trace-summaries
FindTraceSummaries searches for traces matching the given query and streams back lightweight summary information for each matching trace. Each response chunk may contain one or more summaries. Use th…
QueryService_FindTraceSummaries body → 200default
GET
/api/v3/traces
FindTraces searches for traces. See GetTrace for JSON unmarshalling.
QueryService_FindTraces 8 params → 200default
POST
/api/v3/traces
FindTraces searches for traces. See GetTrace for JSON unmarshalling.
QueryService_FindTracesPost body → 200default
GET
/api/v3/traces/{traceId}
GetTrace returns a single trace. Note that the JSON response over HTTP is wrapped into result envelope "{"result": ...}" It means that the JSON response cannot be directly unmarshalled using JSONPb.…
QueryService_GetTrace 4 params → 200default

Schemas 26

The contract defines 26 schemas that model the data the API accepts and returns. The most detailed are opentelemetry.proto.trace.v1.Span (16 properties), jaeger.api_v3.TraceSummary (9 properties), jaeger.api_v3.TraceQueryParameters (9 properties), opentelemetry.proto.common.v1.AnyValue (7 properties). Each schema is shown below with its type and property counts.

opentelemetry.proto.trace.v1.Span
object
A Span represents a single operation performed by a single component of the system. The next available field id is 17.
16 properties
google.rpc.Status
object
The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](h…
3 properties
jaeger.api_v3.FindTraceSummariesResponse
object
Response chunk for FindTraceSummaries. A single RPC call may yield multiple chunks, each carrying one or more summaries, mirroring the chunked streaming used b…
1 property
opentelemetry.proto.common.v1.KeyValueList
object
KeyValueList is a list of KeyValue messages. We need KeyValueList as a message since oneof in AnyValue does not allow repeated fields. Everywhere else where we…
1 property
google.protobuf.Any
object
Contains an arbitrary serialized message along with a @type that describes the type of the serialized message.
1 property
opentelemetry.proto.trace.v1.ScopeSpans
object
A collection of Spans produced by an InstrumentationScope.
3 properties
opentelemetry.proto.common.v1.AnyValue
object
AnyValue is used to represent any type of attribute value. AnyValue may contain a primitive value such as a string or integer or it may contain an arbitrary ne…
7 properties
opentelemetry.proto.common.v1.KeyValue
object
KeyValue is a key-value pair that is used to store Span attributes, Link attributes, etc.
2 properties
opentelemetry.proto.trace.v1.ResourceSpans
object
A collection of ScopeSpans from a Resource.
3 properties
opentelemetry.proto.common.v1.InstrumentationScope
object
InstrumentationScope is a message representing the instrumentation scope information such as the fully qualified name and version.
4 properties
jaeger.api_v3.DependenciesResponse
object
1 property 1 required
jaeger.api_v3.FindTracesRequest
object
Request object to search traces.
1 property
jaeger.api_v3.TraceSummary
object
TraceSummary contains lightweight summary information about a trace, suitable for display in search result lists.
9 properties 1 required
opentelemetry.proto.trace.v1.Span_Event
object
Event is a time-stamped annotation of the span, consisting of user-supplied text description and key-value pairs.
4 properties
jaeger.api_v3.Operation
object
Operation encapsulates information about operation.
2 properties 2 required
jaeger.api_v3.Dependency
object
3 properties 3 required
opentelemetry.proto.trace.v1.Span_Link
object
A pointer from the current span to another span in the same trace or in a different trace. For example, this can be used in batching operations, where a single…
6 properties
jaeger.api_v3.GetServicesResponse
object
Response object to get service names.
1 property 1 required
jaeger.api_v3.GetOperationsResponse
object
Response object to get operation names.
1 property 1 required
opentelemetry.proto.trace.v1.Status
object
The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs.
2 properties
jaeger.api_v3.FindTraceSummariesRequest
object
Request object for FindTraceSummaries.
1 property
opentelemetry.proto.common.v1.ArrayValue
object
ArrayValue is a list of AnyValue messages. We need ArrayValue as a message since oneof in AnyValue does not allow repeated fields.
1 property
opentelemetry.proto.resource.v1.Resource
object
Resource information.
2 properties
opentelemetry.proto.trace.v1.TracesData
object
TracesData represents the traces data that can be stored in a persistent storage, OR can be embedded by other protocols that transfer OTLP traces data but do n…
1 property
jaeger.api_v3.ServiceSummary
object
ServiceSummary contains per-service statistics for a trace, matching what the UI renders as a coloured tag in the search results row.
3 properties 1 required
jaeger.api_v3.TraceQueryParameters
object
Query parameters to find traces. All fields form a conjunction (e.g., "servicename='X' AND operationname='Y' AND ..."), except for searchdepth and rawtraces. F…
9 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

jaeger-io-queryservice-api-openapi.yml Raw ↑

Other APIs Jaeger publishes across the network.

Jaeger CollectorService API
Jaeger SamplingManager API