Create Events
curl --request POST \
--url https://api.honeycomb.io/1/batch/{datasetSlug} \
--header 'Content-Type: application/json' \
--header 'X-Honeycomb-Team: <api-key>' \
--data '
[
{
"time": "2006-01-02T15:04:05.99Z",
"samplerate": 1,
"data": {
"method": "GET",
"endpoint": "/foo",
"shard": "users",
"duration_ms": 32
}
},
{
"time": "2006-01-02T15:04:05.99Z",
"data": {
"some_other_key": "value",
"duration_ms": 40
}
}
]
'import requests
url = "https://api.honeycomb.io/1/batch/{datasetSlug}"
payload = [
{
"time": "2006-01-02T15:04:05.99Z",
"samplerate": 1,
"data": {
"method": "GET",
"endpoint": "/foo",
"shard": "users",
"duration_ms": 32
}
},
{
"time": "2006-01-02T15:04:05.99Z",
"data": {
"some_other_key": "value",
"duration_ms": 40
}
}
]
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([
{
time: '2006-01-02T15:04:05.99Z',
samplerate: 1,
data: {method: 'GET', endpoint: '/foo', shard: 'users', duration_ms: 32}
},
{
time: '2006-01-02T15:04:05.99Z',
data: {some_other_key: 'value', duration_ms: 40}
}
])
};
fetch('https://api.honeycomb.io/1/batch/{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/batch/{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([
[
'time' => '2006-01-02T15:04:05.99Z',
'samplerate' => 1,
'data' => [
'method' => 'GET',
'endpoint' => '/foo',
'shard' => 'users',
'duration_ms' => 32
]
],
[
'time' => '2006-01-02T15:04:05.99Z',
'data' => [
'some_other_key' => 'value',
'duration_ms' => 40
]
]
]),
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/batch/{datasetSlug}"
payload := strings.NewReader("[\n {\n \"time\": \"2006-01-02T15:04:05.99Z\",\n \"samplerate\": 1,\n \"data\": {\n \"method\": \"GET\",\n \"endpoint\": \"/foo\",\n \"shard\": \"users\",\n \"duration_ms\": 32\n }\n },\n {\n \"time\": \"2006-01-02T15:04:05.99Z\",\n \"data\": {\n \"some_other_key\": \"value\",\n \"duration_ms\": 40\n }\n }\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/batch/{datasetSlug}")
.header("X-Honeycomb-Team", "<api-key>")
.header("Content-Type", "application/json")
.body("[\n {\n \"time\": \"2006-01-02T15:04:05.99Z\",\n \"samplerate\": 1,\n \"data\": {\n \"method\": \"GET\",\n \"endpoint\": \"/foo\",\n \"shard\": \"users\",\n \"duration_ms\": 32\n }\n },\n {\n \"time\": \"2006-01-02T15:04:05.99Z\",\n \"data\": {\n \"some_other_key\": \"value\",\n \"duration_ms\": 40\n }\n }\n]")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.honeycomb.io/1/batch/{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 {\n \"time\": \"2006-01-02T15:04:05.99Z\",\n \"samplerate\": 1,\n \"data\": {\n \"method\": \"GET\",\n \"endpoint\": \"/foo\",\n \"shard\": \"users\",\n \"duration_ms\": 32\n }\n },\n {\n \"time\": \"2006-01-02T15:04:05.99Z\",\n \"data\": {\n \"some_other_key\": \"value\",\n \"duration_ms\": 40\n }\n }\n]"
response = http.request(request)
puts response.read_body[
{
"status": 202
},
{
"status": 400,
"error": "Request body should not be empty."
},
{
"status": 400,
"error": "Event has too many columns."
},
{
"status": 400,
"error": "Request body is malformed and cannot be read."
}
]Create Events
Supports batch creation of events.
Dataset names are case insensitive. POST requests to “MyDatasET” will land in the same dataset as “mydataset”. Names may contain URL-encoded spaces or other special characters, but not URL-encoded slashes. For example, “My%20Dataset” will show up in the UI as “My Dataset”.
The first event received for a dataset determines the casing of the displayed name. All subsequent variations in casing will use the originally specified case.
POST
/
1
/
batch
/
{datasetSlug}
Create Events
curl --request POST \
--url https://api.honeycomb.io/1/batch/{datasetSlug} \
--header 'Content-Type: application/json' \
--header 'X-Honeycomb-Team: <api-key>' \
--data '
[
{
"time": "2006-01-02T15:04:05.99Z",
"samplerate": 1,
"data": {
"method": "GET",
"endpoint": "/foo",
"shard": "users",
"duration_ms": 32
}
},
{
"time": "2006-01-02T15:04:05.99Z",
"data": {
"some_other_key": "value",
"duration_ms": 40
}
}
]
'import requests
url = "https://api.honeycomb.io/1/batch/{datasetSlug}"
payload = [
{
"time": "2006-01-02T15:04:05.99Z",
"samplerate": 1,
"data": {
"method": "GET",
"endpoint": "/foo",
"shard": "users",
"duration_ms": 32
}
},
{
"time": "2006-01-02T15:04:05.99Z",
"data": {
"some_other_key": "value",
"duration_ms": 40
}
}
]
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([
{
time: '2006-01-02T15:04:05.99Z',
samplerate: 1,
data: {method: 'GET', endpoint: '/foo', shard: 'users', duration_ms: 32}
},
{
time: '2006-01-02T15:04:05.99Z',
data: {some_other_key: 'value', duration_ms: 40}
}
])
};
fetch('https://api.honeycomb.io/1/batch/{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/batch/{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([
[
'time' => '2006-01-02T15:04:05.99Z',
'samplerate' => 1,
'data' => [
'method' => 'GET',
'endpoint' => '/foo',
'shard' => 'users',
'duration_ms' => 32
]
],
[
'time' => '2006-01-02T15:04:05.99Z',
'data' => [
'some_other_key' => 'value',
'duration_ms' => 40
]
]
]),
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/batch/{datasetSlug}"
payload := strings.NewReader("[\n {\n \"time\": \"2006-01-02T15:04:05.99Z\",\n \"samplerate\": 1,\n \"data\": {\n \"method\": \"GET\",\n \"endpoint\": \"/foo\",\n \"shard\": \"users\",\n \"duration_ms\": 32\n }\n },\n {\n \"time\": \"2006-01-02T15:04:05.99Z\",\n \"data\": {\n \"some_other_key\": \"value\",\n \"duration_ms\": 40\n }\n }\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/batch/{datasetSlug}")
.header("X-Honeycomb-Team", "<api-key>")
.header("Content-Type", "application/json")
.body("[\n {\n \"time\": \"2006-01-02T15:04:05.99Z\",\n \"samplerate\": 1,\n \"data\": {\n \"method\": \"GET\",\n \"endpoint\": \"/foo\",\n \"shard\": \"users\",\n \"duration_ms\": 32\n }\n },\n {\n \"time\": \"2006-01-02T15:04:05.99Z\",\n \"data\": {\n \"some_other_key\": \"value\",\n \"duration_ms\": 40\n }\n }\n]")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.honeycomb.io/1/batch/{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 {\n \"time\": \"2006-01-02T15:04:05.99Z\",\n \"samplerate\": 1,\n \"data\": {\n \"method\": \"GET\",\n \"endpoint\": \"/foo\",\n \"shard\": \"users\",\n \"duration_ms\": 32\n }\n },\n {\n \"time\": \"2006-01-02T15:04:05.99Z\",\n \"data\": {\n \"some_other_key\": \"value\",\n \"duration_ms\": 40\n }\n }\n]"
response = http.request(request)
puts response.read_body[
{
"status": 202
},
{
"status": 400,
"error": "Request body should not be empty."
},
{
"status": 400,
"error": "Event has too many columns."
},
{
"status": 400,
"error": "Request body is malformed and cannot be read."
}
]Authorizations
configuration_keyingest_key
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.
Headers
Included when sending events in a file. Size limitations may be addressed by compressing request bodies with gzip or zstd compression. Be sure to set the Content-Encoding to gzip or zstd when compressing the request body. If sending plaintext, omit this header; "plaintext" is included to simplify the example with curl.
Available options:
gzip, zstd Path Parameters
The dataset slug.
Body
application/jsonapplication/octet-stream
The array should contain one or more JSON objects representing Events. Each Event contains its payload under the data key. Values of time and/or samplerate can be included as well.
The JSON payload should have the structure:
[{ "data": { "key1": "value1", "key2": 2.0 } }, ... ]
Size limitations may be addressed by compressing request bodies with gzip or zstd compression.
An empty 202 response indicates that the event has been queued for processing.
Show child attributes
Show child attributes
Should be in RFC3339 high precision format (for example, YYYY-MM-DDTHH:MM:SS.mmmZ). May be a Unix epoch (seconds since 1970) with second or greater precision (for example, 1452759330927). Optional. If not set, defaults to the time that the API receives the event.