Columns

List all Columns

Get all the Columns in a dataset or environment. Use __all__ as the dataset slug to retrieve all Columns across all datasets in the environment (not available for classic environments).

get/1/columns/{datasetSlug}

Request

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

Query parameters

key_namestring

the column key name

Response

When listing all columns, an array of Column objects will be returned. When using key_name, will return a single Column object if found.

OR

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.