Skip to main content
POST
/
1
/
datasets
Create a Dataset
curl --request POST \
  --url https://api.honeycomb.io/1/datasets \
  --header 'Content-Type: application/json' \
  --header 'X-Honeycomb-Team: <api-key>' \
  --data '
{
  "name": "<string>",
  "description": "A nice description of my dataset",
  "expand_json_depth": 3
}
'
{
  "name": "My Dataset!",
  "description": "A nice description of my dataset",
  "settings": {
    "delete_protected": true
  },
  "expand_json_depth": 3,
  "slug": "my-dataset-",
  "regular_columns_count": 100,
  "last_written_at": "2022-07-21T18:39:23Z",
  "created_at": "2022-09-22T17:32:11Z"
}

Authorizations

​
X-Honeycomb-Team
string
header
required

A Honeycomb Configuration Key is required to use this API. A Configuration Key can be found in the API Keys section of the environment configuration, which can be found under Environment Settings -> API Keys -> Configuration tab. Check out our documentation to find your API Keys.

More information can be found in Manage Environments.

Body

application/json

The dataset will be created within the environment associated with your API key.

an object to send to the Dataset API via PUT

​
name
string
required

The name of the dataset.

Required string length: 1 - 255
​
description
string
default:""

A description for the dataset.

Maximum string length: 1024
Example:

"A nice description of my dataset"

​
expand_json_depth
integer
default:0

The maximum unpacking depth of nested JSON fields.

Required range: 0 <= x <= 10
Example:

3

Response

OK - Dataset already exists

Datasets are a collection of events from a specific source or related source.

​
name
string
required

The name of the dataset.

Required string length: 1 - 255
Example:

"My Dataset!"

​
description
string
default:""

A description for the dataset.

Maximum string length: 1024
Example:

"A nice description of my dataset"

​
settings
object
​
expand_json_depth
integer
default:0

The maximum unpacking depth of nested JSON fields.

Required range: 0 <= x <= 10
Example:

3

​
slug
string

The 'slug' of the dataset to be used in URLs.

Example:

"my-dataset-"

​
regular_columns_count
null | integer

The total number of unique fields for this Dataset. The value will be null if the dataset does not contain any fields yet.

Example:

100

​
last_written_at
null | string

The ISO8601-formatted time when the dataset last received event data. The value will be null if no data has been received yet.

Example:

"2022-07-21T18:39:23Z"

​
created_at
string

The ISO8601-formatted time when the dataset was created.

Example:

"2022-09-22T17:32:11Z"