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 Queries API

Queries in Honeycomb are specifications for queries, and are used to identify queries in other parts of the API - in particular: boards, triggers, and query annotations.This API allows you to create and get query objects.## AuthorizationThe API key must have the **Manage Queries and Columns** permission. Learn more about [API keys here](https://docs.honeycomb.io/configure/environments/manage-api-keys/).

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

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

This API exposes 2 operations across 2 paths, and defines 12 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 12 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.

Queries 2

Queries in Honeycomb are specifications for queries, and are used to identify queries in other parts of the API - in particular: boards, triggers, and query annotations. This API…

POST
/1/queries/{datasetSlug}
Create a Query
createQuery 1 param body → 200400404422429
GET
/1/queries/{datasetSlug}/{queryId}
Get a Query
getQuery 2 params → 200403404429

Schemas 12

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

HavingOp
string
FilterValue
FilterOp
string
Query
object
16 properties
Error
object
A legacy error, containing only a textual description.
1 property
HavingCalculateOp
string
QueryOp
string
ValidationError
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-queries-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