HOhoneycomb
Columns

Get a Column

get/1/columns/{datasetSlug}/{columnId}

Request

  • Base URL
    https://api.honeycomb.io
  • URL
    https://api.honeycomb.io/1/columns/{datasetSlug}/{columnId}
  • Auth
    API key in header X-Honeycomb-Team

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"
}

Changes

No recorded changes to this operation across all 2 revisions of this API.