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

Highlight (highlight.io) Traces API

OpenTelemetry trace ingestion

Highlight (highlight.io) Traces API is one of 8 APIs that Highlight (highlight.io) publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 3 JSON Schema definitions.

Tagged areas include Traces. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 3 JSON Schemas.

This API exposes 1 operation across 1 path, and defines 13 schemas. It is described by OpenAPI 3.1.0, at version 1.0.

Requests are made against 2 base URLs: https://otel.highlight.io, http://localhost:4318.

1 operations 1 paths 13 schemas 1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0
Servers
https://otel.highlight.io
http://localhost:4318
License
Resource Areas
1

Paths & Operations 1

Across 1 path, the API surfaces 1 operation — 1 POST. Each is listed below with its method, path, parameters, and response codes.

Traces 1

OpenTelemetry trace ingestion

POST
/v1/traces
Export Trace Service
exportTraces body → 200400413429

Schemas 13

The contract defines 13 schemas that model the data the API accepts and returns. The most detailed are Span (11 properties), AnyValue (5 properties), ResourceSpans (3 properties), SpanLink (3 properties). Each schema is shown below with its type and property counts.

ResourceSpans
object
3 properties
ExportTraceServiceRequest
object
OpenTelemetry export envelope for trace data.
1 property 1 required
ScopeSpans
object
2 properties
Resource
object
Resource attributes describing the entity emitting the spans.
1 property
Span
object
11 properties 5 required
Status
object
2 properties
KeyValue
object
2 properties 2 required
ErrorResponse
object
3 properties
InstrumentationScope
object
2 properties
SpanEvent
object
3 properties
SpanLink
object
3 properties
AnyValue
object
5 properties
ExportTraceServiceResponse
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

highlight-io-traces-api-openapi.yml Raw ↑

Other APIs Highlight (highlight.io) publishes across the network.

Highlight Private GraphQL API
Highlight Webhooks API
Highlight Self-Hosted Deployment
Highlight (highlight.io) Logs API
Highlight (highlight.io) Metrics API
Highlight (highlight.io) Sessions API
Highlight (highlight.io) Webhooks API