Honeycomb Queries API
The Honeycomb Queries API allows developers to programmatically create and manage query specifications within Honeycomb. Queries are used to identify and reference queries across other parts of the API, including boards, triggers, and query annotations. Developers can run queries asynchronously by creating a Query Result that references a Query ID, then polling the query result endpoint until the data is ready. The Query Data API complements this by providing access to query results.
Honeycomb Queries API is one of 22 APIs that honeycomb publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Analytics, Data Analysis, Observability, and Queries. The published artifact set on APIs.io includes API documentation and an OpenAPI specification.
This API exposes 2 operations across 2 paths, and defines 2 schemas. It is described by OpenAPI 3.1.0, at version 1.0.
Requests are made against a single base URL, https://api.honeycomb.io.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Honeycomb Queries API declares
1 security scheme
for authenticating requests.
An API key is passed in the header as X-Honeycomb-Team (ApiKeyAuth).
By default, every request must be authenticated.
ApiKeyAuth— Honeycomb Configuration API key. Must have appropriate permissions for the endpoint being called.
Paths & Operations 2
Across 2 paths, the API surfaces 2 operations — 1 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.
Create and retrieve query specifications that define what data to retrieve and how to aggregate it.
Schemas 2
The contract defines 2 schemas that model the data the API accepts and returns. The most detailed are QuerySpec (11 properties), Query (9 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from honeycomb 12
Other APIs honeycomb publishes across the network.