Sign in

v1

latestOpenAPI 3.1.0Apache 2.02026-07-2685126228.9 KB
Query Data

Create a Query Result

Kick off processing of a Query to then get back the Query Results. Once the Query Result has been created, the query will be run asynchronously, allowing the result data to be fetched from the GET query result endpoint. A maximum duration of 7 days of data can be queried. Any queries with a start_time, end_time, or time_range resulting in a duration longer than 7 days will result in a 400 error response.

post/1/query_results/{datasetSlug}

Request body

query_idstring required

The ID of a query returned from the Queries endpoint.

disable_seriesboolean

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_aggregateboolean

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_aggregateboolean

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

limitinteger

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.

Example request

{
  "query_id": "mabAMpSPDjH"
}

Response

Created

idstring

The unique identifier (ID) of a Query Result.

completeboolean

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

Example response

{
  "id": "sGUnkBHgRFN",
  "links": {
    "query_url": "https://ui.honeycomb.io/myteam/datasets/test-via-curl/result/HprJhV1fYy",
    "graph_image_url": "https://ui.honeycomb.io/myteam/datasets/test-via-curl/result/HprJhV1fYy/snapshot"
  }
}