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

Honeycomb Query Data API

This feature is available as part of the [Honeycomb Enterprise plan](https://www.honeycomb.io/pricing/).Query Results are the aggregated data from a Query, similar to what is displayed in graphs or heatmaps within the Honeycomb UI. Receiving results from a Query is a three-step process:Create the Query (or Query Spec), which validates that the query parameters are valid. Creating a query does not actually run the query to get results.Run the query asynchronously by creating a Query Result referencing the Query’s ID. This returns a Query Result ID.Poll the query result endpoint (with the Query Result ID) until the data is ready.Note that many Query Results can be created from a single Query. This is particularly useful when using a relative time_range parameter in the Query.For example, a Query with `time_range: 7200` and no explicit `start_time` or `end_time` can be re-run over and over, with each resulting Query Result containing the most recent 2 hours of data.This is conceptually similar to clicking Run Query in the Honeycomb UI without changing any query parameters.**IMPORTANT API RESTRICTIONS:**To ensure the stability of Honeycomb systems, we have enabled the following API restrictions. These restrictions may change over time.* Query Results can only be created for events with timestamps within the past 7 days.* When creating a Query Result, the time ranges from the Query are truncated according to the following rules. For queries with a time range of: * less than or equal to 6 hours, results are truncated to the nearest 1 minute. For example, astart/end time of 2021-04-22T05:28:12Z will be truncated to 2021-04-22T05:28:00Z. * greater than 6 hours and less than or equal to 2 days, results are truncated to the nearest5 minutes. For example, a start/end time of 2021-04-22T05:28:12Z will be truncated to 2021-04-22T05:25:00Z. * greater than 2 days and less than or equal to 7 days, results are truncated to the nearest 30minutes. For example, a start/end time of 2021-04-22T05:28:12Z will be truncated to 2021-04-22T05:00:00Z.* Creating a Query Result is rate limited to 10 requests per minute. Status code 429 will be returned when rate limited.* Query Results cannot take longer than 10 seconds to run.* Creating a Query Result that contains Relational Fields is rate limited to 1 request per minute. Status code 429 will be returned when rate limited. * Query Results with Relational Fields may be more likely to take longer to run.* Regardless of whether the `compare_time_offset_seconds` field is populated on a query, query run responses will not include comparison results.## AuthorizationThe API key must have the **Manage Queries and Columns** and **Run Queries** permission. Learn more about [API keys here](https://docs.honeycomb.io/configure/environments/manage-api-keys/).

Honeycomb Query Data API is one of 21 APIs that Honeycomb publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Query Data. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

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

Requests are made against 2 base URLs: https://api.honeycomb.io, https://api.eu1.honeycomb.io.

2 operations 2 paths 17 schemas 1 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0.0
Base URL
https://api.honeycomb.io
License
Resource Areas
1

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.

Query Data 2

This feature is available as part of the [Honeycomb Enterprise plan](https://www.honeycomb.io/pricing/). Query Results are the aggregated data from a Query, similar to what is dis…

POST
/1/query_results/{datasetSlug}
Create a Query Result
createQueryResult 1 param body → 201400403404422429default
GET
/1/query_results/{datasetSlug}/{queryResultId}
Get Query Result
getQueryResult 2 params → 200404default

Schemas 17

The contract defines 17 schemas that model the data the API accepts and returns. The most detailed are Query (16 properties), DetailedError (6 properties), CreateQueryResultRequest (5 properties), QueryResultDetails (5 properties). Each schema is shown below with its type and property counts.

HavingOp
string
FilterValue
QueryResultsSeries
object
1 property
FilterOp
string
QueryResult
object
A Query Result is created with the Query ID.
4 properties
Query
object
16 properties
Error
object
A legacy error, containing only a textual description.
1 property
HavingCalculateOp
string
QueryOp
string
CreateQueryResultRequest
object
A Query Result is created with the Query ID.
5 properties 1 required
ValidationError
QueryResultsData
object
Query result details
1 property
QueryResultDetails
object
Query Results for the Query ID. The response body will be a JSON object with "complete": true and the results populated once the query is complete. The respons…
5 properties
FilterColumn
nullstring
DetailedError
object
An RFC7807 'Problem Detail' formatted error message.
6 properties 4 required
JSONAPIError
object
A JSONAPI-formatted error message.
1 property
FilterCombination
string
Set to "OR" to match ANY filter in the filter list

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

honeycomb-io-query-data-api-openapi.yml Raw ↑

Other APIs Honeycomb publishes across the network.

Honeycomb Auth API
Honeycomb Boards API
Honeycomb Burn Alerts API
Honeycomb Calculated Fields API
Honeycomb Columns API
Honeycomb Dataset Definitions API
Honeycomb Datasets API
Honeycomb Environments API
Honeycomb Events API
Honeycomb Key Management API
Honeycomb Kinesis Events API
Honeycomb Marker Settings API