Sign in

v1

latestOpenAPI 3.1.0Apache 2.02026-07-2685126228.9 KB
Columns

Create a Column

Create a column by providing corresponding details for that type.

post/1/columns/{datasetSlug}

Request body

key_namestring required

Name of the Column.

type'string' | 'float' | 'integer' | 'boolean' | 'histogram'

Type of data that the Column will contain. Histogram is in beta and only works in your Metrics dataset.

descriptionstring

Column description.

hiddenboolean

If true, the column is excluded from autocomplete and raw data field lists.

idstring

Unique identifier (ID), returned in response bodies.

last_writtenstring

ISO8601 formatted time the column was last written to (received event data).

created_atstring

ISO8601 formatted time the column was created.

updated_atstring

ISO8601 formatted time the column was updated.

Example request

{
  "key_name": "my_column",
  "type": "integer",
  "description": "An integer column"
}

Response

Success

key_namestring required

Name of the Column.

type'string' | 'float' | 'integer' | 'boolean' | 'histogram'

Type of data that the Column will contain. Histogram is in beta and only works in your Metrics dataset.

descriptionstring

Column description.

hiddenboolean

If true, the column is excluded from autocomplete and raw data field lists.

idstring

Unique identifier (ID), returned in response bodies.

last_writtenstring

ISO8601 formatted time the column was last written to (received event data).

created_atstring

ISO8601 formatted time the column was created.

updated_atstring

ISO8601 formatted time the column was updated.

Example response

{
  "key_name": "my_column",
  "type": "integer",
  "description": "An integer column"
}