{
"duration_ms": {
"name": "duration_ms",
"column_type": "column"
},
"error": null,
"name": null,
"parent_id": null,
"route": null,
"service_name": null,
"span_id": {
"name": "my_span_id",
"column_type": "column"
},
"span_kind": null,
"annotation_type": null,
"link_trace_id": null,
"link_span_id": null,
"status": null,
"trace_id": null,
"user": null,
"log_severity": null,
"log_message": null
}{
"status": 400,
"type": "https://api.honeycomb.io/problems/unparseable",
"title": "The request body could not be parsed.",
"detail": "could not parse request body",
"error": "could not parse request body"
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "The following columns were not found: duration_we_send"
}Set or Update Dataset Definitions
Set or update one or more definitions for a Dataset.
Note: While the PATCH payload can include the column_type, Honeycomb does not use this field when updating Dataset Definitions.
{
"duration_ms": {
"name": "duration_ms",
"column_type": "column"
},
"error": null,
"name": null,
"parent_id": null,
"route": null,
"service_name": null,
"span_id": {
"name": "my_span_id",
"column_type": "column"
},
"span_kind": null,
"annotation_type": null,
"link_trace_id": null,
"link_span_id": null,
"status": null,
"trace_id": null,
"user": null,
"log_severity": null,
"log_message": null
}{
"status": 400,
"type": "https://api.honeycomb.io/problems/unparseable",
"title": "The request body could not be parsed.",
"detail": "could not parse request body",
"error": "could not parse request body"
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "The following columns were not found: duration_we_send"
}Authorizations
Authenticate using a Honeycomb Configuration Key.
Pass the Token in the X-Honeycomb-Team header:
X-Honeycomb-Team: 1234567890123456789012
If you created your key using the API, use data.attributes.secret; this is the same value as the Token in the UI.
To learn how to create a Configuration Key, visit Manage Environment API Keys. To learn more about authenticating requests, visit API Authentication.
Path Parameters
The dataset slug.
Body
The PATCH payload takes a map of Dataset definition type to Dataset definition. Fields not defined in the request are not modified on the server. Note: In order to CLEAR a column of a Dataset definition set the column’s name field to an empty string.
Dataset Definitions describe the fields with special meaning in the Dataset.
The unique identifier (ID) for each span.
Show child attributes
Show child attributes
The ID of the trace this span belongs to.
Show child attributes
Show child attributes
The Parent Span ID - The ID of this span's parent span, the call location the current span was called from.
Show child attributes
Show child attributes
The name of the function or method where the span was created.
Show child attributes
Show child attributes
The name of the instrumented service.
Show child attributes
Show child attributes
Span Duration - How much time the span took, in milliseconds.
Show child attributes
Show child attributes
Metadata: Kind - The kind of Span. For example, client or server. The use of this field to identify Span Events and Links is deprecated. Use the field Metadata: Annotation Type.
Show child attributes
Show child attributes
Metadata: Annotation Type - The type of span annotation. For example, span_event or link. This lets Honeycomb visualize this type of event differently in a trace. Do not use this field for other purposes.
Show child attributes
Show child attributes
Metadata: Link Span ID - Links let you tie traces and spans to one another. The Link Span ID lets you link to a different span (when used with Link Trace ID).
Show child attributes
Show child attributes
Metadata: Link Trace ID - Links let you tie traces and spans to one another. The Link Trace Id lets you link to a different trace or a different span in the same trace (when used with Link Span ID).
Show child attributes
Show child attributes
Use a Boolean or String to indicate error.
Show child attributes
Show child attributes
Indicates the success, failure, or other status of a request.
Show child attributes
Show child attributes
The HTTP URL or equivalent route processed by the request.
Show child attributes
Show child attributes
The user making the request in the system.
Show child attributes
Show child attributes
Severity level of the event (also known as log level). Supported values: trace, debug, info, warn, error, fatal, unspecified.
Show child attributes
Show child attributes
A value containing the log event message. Can be a human-readable string message (including multi-line) describing the event in a free form.
Show child attributes
Show child attributes
Response
Dataset Definitions have been updated
Dataset Definitions describe the fields with special meaning in the Dataset.
The unique identifier (ID) for each span.
Show child attributes
Show child attributes
The ID of the trace this span belongs to.
Show child attributes
Show child attributes
The Parent Span ID - The ID of this span's parent span, the call location the current span was called from.
Show child attributes
Show child attributes
The name of the function or method where the span was created.
Show child attributes
Show child attributes
The name of the instrumented service.
Show child attributes
Show child attributes
Span Duration - How much time the span took, in milliseconds.
Show child attributes
Show child attributes
Metadata: Kind - The kind of Span. For example, client or server. The use of this field to identify Span Events and Links is deprecated. Use the field Metadata: Annotation Type.
Show child attributes
Show child attributes
Metadata: Annotation Type - The type of span annotation. For example, span_event or link. This lets Honeycomb visualize this type of event differently in a trace. Do not use this field for other purposes.
Show child attributes
Show child attributes
Metadata: Link Span ID - Links let you tie traces and spans to one another. The Link Span ID lets you link to a different span (when used with Link Trace ID).
Show child attributes
Show child attributes
Metadata: Link Trace ID - Links let you tie traces and spans to one another. The Link Trace Id lets you link to a different trace or a different span in the same trace (when used with Link Span ID).
Show child attributes
Show child attributes
Use a Boolean or String to indicate error.
Show child attributes
Show child attributes
Indicates the success, failure, or other status of a request.
Show child attributes
Show child attributes
The HTTP URL or equivalent route processed by the request.
Show child attributes
Show child attributes
The user making the request in the system.
Show child attributes
Show child attributes
Severity level of the event (also known as log level). Supported values: trace, debug, info, warn, error, fatal, unspecified.
Show child attributes
Show child attributes
A value containing the log event message. Can be a human-readable string message (including multi-line) describing the event in a free form.
Show child attributes
Show child attributes