Skip to main content
POST
/
1
/
query_results
/
{datasetSlug}
Create a Query Result
curl --request POST \
  --url https://api.honeycomb.io/1/query_results/{datasetSlug} \
  --header 'Content-Type: application/json' \
  --header 'X-Honeycomb-Team: <api-key>' \
  --data '
{
  "query_id": "mabAMpSPDjH",
  "disable_series": false,
  "disable_total_by_aggregate": true,
  "disable_other_by_aggregate": true,
  "limit": 123
}
'
{
  "query": {
    "calculations": [
      {
        "op": "COUNT"
      }
    ],
    "orders": [
      {
        "op": "COUNT",
        "order": "descending"
      }
    ],
    "limit": 10000,
    "time_range": 7200
  },
  "complete": false,
  "id": "dfg456",
  "links": {
    "query_url": "https://ui.honeycomb.io/myteam/datasets/test-via-curl/result/dfg456",
    "graph_image_url": "https://ui.honeycomb.io/myteam/datasets/test-via-curl/result/dfg456/snapshot"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.honeycomb.io/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
X-Honeycomb-Team
string
header
required

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

​
datasetSlug
string
required

The dataset slug or use __all__ for endpoints that support environment-wide operations.

Body

application/json

A Query Result is created with the Query ID.

​
query_id
string
required
write-only

The ID of a query returned from the Queries endpoint.

Example:

"mabAMpSPDjH"

​
disable_series
boolean
default:false
write-only

If true, timeseries data will not be returned in the series response field, and only summarized data will be returned in the results response field.

​
disable_total_by_aggregate
boolean
default:true
write-only

If true, data representing each aggregate in the query's total value will not be returned. Ensure disable_series is false to return the timeseries data.

​
disable_other_by_aggregate
boolean
default:true
write-only

If true, the "other_by_aggregate" data is excluded from the query result.

​
limit
integer
write-only

If disable_series is true, a limit may be optionally given. The limit will override the default limit of 1_000 results with a maximum available limit of 10_000. If disable_series is false, this field will be ignored.

Required range: x <= 10000

Response

Created

A Query Result is created with the Query ID.

​
query
object
​
id
string
read-only

The unique identifier (ID) of a Query Result.

Example:

"sGUnkBHgRFN"

​
complete
boolean
read-only

Indicates if the query results are available yet or not. For example, is the query still being processed or complete?

Example:

false

​
links
object
read-only

An object containing UI links to the query result and query result graph