A Dataset represents a collection of related events that come from the same source, or are related to the same source.
This API allows you to list, create, and update datasets.
The API key must have the Create Datasets permission. Learn more about API keys here.
Create a Dataset in the environment associated with your API key.
If a Dataset already exists by that name (or slug), then the existing dataset will be returned.
The dataset will be created within the environment associated with your API key.
OK - Dataset already exists
Created
Unauthorized
Conflict
Validation Failed
Error
{- "name": "My Dataset!",
- "description": "A nice description of my dataset",
- "expand_json_depth": 3
}
{- "name": "My Dataset!",
- "description": "A nice description of my dataset",
- "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"
}
Lists all Datasets for an environment.
Note: For Honeycomb Classic users, all datasets in Classic are returned.
Success
Unauthorized
Error
[- {
- "name": "my dataset!",
- "description": "my dataset described!",
- "slug": "my-dataset-",
- "expand_json_depth": 2,
- "created_at": "2022-07-21T18:39:23Z",
- "last_written_at": "2022-07-22T19:52:00Z",
- "regular_columns_count": 12
}, - {
- "name": "another dataset",
- "description": "",
- "slug": "another-dataset",
- "expand_json_depth": 0,
- "created_at": "2022-07-21T18:39:23Z",
- "last_written_at": "2022-07-22T19:52:00Z",
- "regular_columns_count": 98
}
]
Get a single Dataset by slug.
Success
Unauthorized
Not Found
Error
{- "name": "My Dataset!",
- "description": "A nice description of my dataset",
- "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"
}
Asynchronously delete a dataset.
WARNING: This endpoint will allow anyone with an API key that has the
manage dataset permission to delete any dataset in the environment (or
any dataset in the whole team for Classic customers).
This might make you sad.
This endpoint is not enabled by default.
If you would like access to this endpoint despite the above-listed risks, please contact Honeycomb Support or email Support.
Deleted
Unauthorized
Not Found
Error
{- "error": "unknown API key - check your credentials"
}
Update a dataset's description
or expand_json_depth
setting.
Updates the Dataset's description
or expand_json_depth
.
Both fields must be specified, as omitting one will have the effect of reverting the setting to the default.
Updated
Unauthorized
Not Found
{- "expand_json_depth": 3,
- "description": "my updated description"
}
{- "name": "My Dataset!",
- "slug": "my-dataset-",
- "description": "my updated description",
- "expand_json_depth": 3,
- "created_at": "2022-07-21T18:39:23Z",
- "last_written_at": "2022-09-22T17:32:03Z",
- "regular_columns_count": 100
}