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
}
'

import requests

url = "https://api.honeycomb.io/1/query_results/{datasetSlug}"

payload = {
    "query_id": "mabAMpSPDjH",
    "disable_series": False,
    "disable_total_by_aggregate": True,
    "disable_other_by_aggregate": True,
    "limit": 123
}
headers = {
    "X-Honeycomb-Team": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-Honeycomb-Team': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    query_id: 'mabAMpSPDjH',
    disable_series: false,
    disable_total_by_aggregate: true,
    disable_other_by_aggregate: true,
    limit: 123
  })
};

fetch('https://api.honeycomb.io/1/query_results/{datasetSlug}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.honeycomb.io/1/query_results/{datasetSlug}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'query_id' => 'mabAMpSPDjH',
    'disable_series' => false,
    'disable_total_by_aggregate' => true,
    'disable_other_by_aggregate' => true,
    'limit' => 123
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-Honeycomb-Team: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.honeycomb.io/1/query_results/{datasetSlug}"

	payload := strings.NewReader("{\n  \"query_id\": \"mabAMpSPDjH\",\n  \"disable_series\": false,\n  \"disable_total_by_aggregate\": true,\n  \"disable_other_by_aggregate\": true,\n  \"limit\": 123\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-Honeycomb-Team", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.honeycomb.io/1/query_results/{datasetSlug}")
  .header("X-Honeycomb-Team", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"query_id\": \"mabAMpSPDjH\",\n  \"disable_series\": false,\n  \"disable_total_by_aggregate\": true,\n  \"disable_other_by_aggregate\": true,\n  \"limit\": 123\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.honeycomb.io/1/query_results/{datasetSlug}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-Honeycomb-Team"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"query_id\": \"mabAMpSPDjH\",\n  \"disable_series\": false,\n  \"disable_total_by_aggregate\": true,\n  \"disable_other_by_aggregate\": true,\n  \"limit\": 123\n}"

response = http.request(request)
puts response.read_body

{
  "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"
  }
}

POST

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
}
'

import requests

url = "https://api.honeycomb.io/1/query_results/{datasetSlug}"

payload = {
    "query_id": "mabAMpSPDjH",
    "disable_series": False,
    "disable_total_by_aggregate": True,
    "disable_other_by_aggregate": True,
    "limit": 123
}
headers = {
    "X-Honeycomb-Team": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-Honeycomb-Team': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    query_id: 'mabAMpSPDjH',
    disable_series: false,
    disable_total_by_aggregate: true,
    disable_other_by_aggregate: true,
    limit: 123
  })
};

fetch('https://api.honeycomb.io/1/query_results/{datasetSlug}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.honeycomb.io/1/query_results/{datasetSlug}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'query_id' => 'mabAMpSPDjH',
    'disable_series' => false,
    'disable_total_by_aggregate' => true,
    'disable_other_by_aggregate' => true,
    'limit' => 123
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-Honeycomb-Team: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.honeycomb.io/1/query_results/{datasetSlug}"

	payload := strings.NewReader("{\n  \"query_id\": \"mabAMpSPDjH\",\n  \"disable_series\": false,\n  \"disable_total_by_aggregate\": true,\n  \"disable_other_by_aggregate\": true,\n  \"limit\": 123\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-Honeycomb-Team", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.honeycomb.io/1/query_results/{datasetSlug}")
  .header("X-Honeycomb-Team", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"query_id\": \"mabAMpSPDjH\",\n  \"disable_series\": false,\n  \"disable_total_by_aggregate\": true,\n  \"disable_other_by_aggregate\": true,\n  \"limit\": 123\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.honeycomb.io/1/query_results/{datasetSlug}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-Honeycomb-Team"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"query_id\": \"mabAMpSPDjH\",\n  \"disable_series\": false,\n  \"disable_total_by_aggregate\": true,\n  \"disable_other_by_aggregate\": true,\n  \"limit\": 123\n}"

response = http.request(request)
puts response.read_body

{
  "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"
  }
}

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

Show child attributes

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

Show child attributes

Delete a Query Annotation Get Query Result

Getting Started

Reference

API Endpoints

Create a Query Result

Authorizations

Path Parameters

Body

Response