# Honeycomb Query Data API **Canonical:** https://apis.io/apis/honeycomb-io/honeycomb-io-query-data-api/ **Provider:** Honeycomb — https://apis.io/providers/honeycomb-io/ **Base URL:** https://api.honeycomb.io **Documentation:** https://docs.honeycomb.io/api/tag/Events Honeycomb Query Data API is one of 21 APIs that [Honeycomb](https://apis.io/providers/honeycomb-io/) publishes on the [APIs.io](https://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 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, a start/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 nearest 5 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 30 minutes. 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. ## Authorization The 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/). ## Machine-readable artifacts (21) - **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/honeycomb-io/refs/heads/main/openapi/honeycomb-io-query-data-api-openapi.yml - **Documentation** — https://docs.honeycomb.io/api/tag/Events - **Documentation** — https://docs.honeycomb.io/api/tag/Datasets - **Documentation** — https://docs.honeycomb.io/api/tag/Dataset-Definitions - **Documentation** — https://docs.honeycomb.io/api/tag/Columns - **Documentation** — https://docs.honeycomb.io/api/tag/Calculated-Fields - **Documentation** — https://docs.honeycomb.io/api/tag/Queries - **Documentation** — https://docs.honeycomb.io/api/tag/Query-Data - **Documentation** — https://docs.honeycomb.io/api/tag/Query-Annotations - **Documentation** — https://docs.honeycomb.io/api/tag/Boards - **Documentation** — https://docs.honeycomb.io/api/tag/Triggers - **Documentation** — https://docs.honeycomb.io/api/tag/Recipients - **Documentation** — https://docs.honeycomb.io/api/tag/SLOs - **Documentation** — https://docs.honeycomb.io/api/tag/Burn-Alerts - **Documentation** — https://docs.honeycomb.io/api/tag/Reporting - **Documentation** — https://docs.honeycomb.io/api/tag/Markers - **Documentation** — https://docs.honeycomb.io/api/tag/Marker-Settings - **Documentation** — https://docs.honeycomb.io/api/tag/Service-Maps - **Documentation** — https://docs.honeycomb.io/api/tag/Auth - **Documentation** — https://docs.honeycomb.io/api/tag/Key-Management - **Documentation** — https://docs.honeycomb.io/api/tag/Environments ## Other Honeycomb APIs (12) - [Honeycomb Auth API](https://apis.io/apis/honeycomb-io/honeycomb-io-auth-api/) - [Honeycomb Boards API](https://apis.io/apis/honeycomb-io/honeycomb-io-boards-api/) - [Honeycomb Burn Alerts API](https://apis.io/apis/honeycomb-io/honeycomb-io-burn-alerts-api/) - [Honeycomb Calculated Fields API](https://apis.io/apis/honeycomb-io/honeycomb-io-calculated-fields-api/) - [Honeycomb Columns API](https://apis.io/apis/honeycomb-io/honeycomb-io-columns-api/) - [Honeycomb Dataset Definitions API](https://apis.io/apis/honeycomb-io/honeycomb-io-dataset-definitions-api/) - [Honeycomb Datasets API](https://apis.io/apis/honeycomb-io/honeycomb-io-datasets-api/) - [Honeycomb Environments API](https://apis.io/apis/honeycomb-io/honeycomb-io-environments-api/) - [Honeycomb Events API](https://apis.io/apis/honeycomb-io/honeycomb-io-events-api/) - [Honeycomb Key Management API](https://apis.io/apis/honeycomb-io/honeycomb-io-key-management-api/) - [Honeycomb Kinesis Events API](https://apis.io/apis/honeycomb-io/honeycomb-io-kinesis-events-api/) - [Honeycomb Marker Settings API](https://apis.io/apis/honeycomb-io/honeycomb-io-marker-settings-api/) ## Tags Query Data --- Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/honeycomb-io/honeycomb-io-query-data-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/honeycomb-io/.