Sign in

v1

latestOpenAPI 3.1.0Apache 2.02026-07-2685126228.9 KB
Datasets

Create a Dataset

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.

post/1/datasets

Request body

namestring required

The name of the dataset.

descriptionstring

A description for the dataset.

expand_json_depthinteger

The maximum unpacking depth of nested JSON fields.

Example request

{
  "description": "A nice description of my dataset",
  "expand_json_depth": 3
}

Response

OK - Dataset already exists

namestring required

The name of the dataset.

descriptionstring

A description for the dataset.

expand_json_depthinteger

The maximum unpacking depth of nested JSON fields.

slugstring

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

regular_columns_countinteger nullable

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

last_written_atstring nullable

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

created_atstring

The ISO8601-formatted time when the dataset was created.

dataset_type'metrics'

The type of data contained in the dataset. Only present for time-series metrics datasets.

Example response

{
  "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",
  "dataset_type": "metrics"
}