logo

Columns

Columns are fields in the events you send to Honeycomb.

This API allows you to list, create, update, and delete columns in a dataset.

Authorization

The API key must have the Manage Queries and Columns permission. Learn more about API keys here.

Create a Column

Create a column by providing corresponding details for that type.

Securityapi_key
Request
path Parameters
datasetSlug
required
string

The dataset slug.

Request Body schema: application/json
required
key_name
required
string [ 1 .. 255 ] characters

Name of the Column.

type
string
Default: "string"

Type of the data that the Column will contain.

Enum: "string" "float" "integer" "boolean"
description
string <= 255 characters

Column description.

hidden
boolean
Default: false

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

Responses
201

Success

400

Bad Request

401

Unauthorized

404

Not Found

post/1/columns/{datasetSlug}
Request samples
application/json
{
  • "key_name": "my_column",
  • "type": "integer",
  • "description": "An integer column",
  • "hidden": false
}
Response samples
application/json
{
  • "id": "yUheCUmgZ8p",
  • "key_name": "my_column",
  • "hidden": false,
  • "description": "An integer column",
  • "type": "integer",
  • "last_written": "2022-07-26T22:38:05Z",
  • "created_at": "2022-07-26T22:38:04Z",
  • "updated_at": "2022-07-26T22:38:04Z"
}

List all Columns

Get all the Columns in a dataset

Securityapi_key
Request
path Parameters
datasetSlug
required
string

The dataset slug.

query Parameters
key_name
string

the column key name

Responses
200

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

401

Unauthorized

404

Not Found

get/1/columns/{datasetSlug}
Request samples 
Response samples 
application/json
Lists all columns.


[
  • {
    },
  • {
    }
]
Get a Column
Securityapi_key 
Request 
path Parameters
datasetSlug
required
string
The dataset slug.


 
columnId
required
string
Unique identifier (ID) of a column.


 
Responses 
200
Success


400
Bad Request


401
Unauthorized


404
Not Found


get/1/columns/{datasetSlug}/{columnId}
Request samples 
Response samples 
application/json
{
  • "id": "yUheCUmgZ8p",
  • "key_name": "my_column",
  • "hidden": false,
  • "description": "",
  • "type": "integer",
  • "last_written": "2022-07-26T22:38:05Z",
  • "created_at": "2022-07-26T22:38:04Z",
  • "updated_at": "2022-07-26T22:38:04Z"
}
Update a Column
Update a column


Securityapi_key 
Request 
path Parameters
datasetSlug
required
string
The dataset slug.


 
columnId
required
string
Unique identifier (ID) of a column.


 
Request Body schema: application/json
required
type
string
 Default:  "string"
Type of the data that the Column will contain.


 Enum: "string" "float" "integer" "boolean"  
description
string  <= 255 characters 
Column description.


 
hidden
boolean
 Default:  false
If true, the column is excluded from autocomplete and raw data field lists.


 
Responses 
200
Success


400
Bad Request


401
Unauthorized


404
Not Found


put/1/columns/{datasetSlug}/{columnId}
Request samples 
application/json
{
  • "key_name": "my_column",
  • "type": "integer",
  • "description": "An integer column",
  • "hidden": false
}
Response samples 
application/json
{
  • "id": "yUheCUmgZ8p",
  • "key_name": "my_column",
  • "hidden": false,
  • "description": "",
  • "type": "string",
  • "last_written": "2022-07-26T22:38:05Z",
  • "created_at": "2022-07-26T22:38:04Z",
  • "updated_at": "2022-07-26T22:38:04Z"
}
Delete a Column
Delete a column. Note: Deleted columns are no longer queryable, but data in existing permalinks (query results and trace views) will remain stored and available at those links.


Securityapi_key 
Request 
path Parameters
datasetSlug
required
string
The dataset slug.


 
columnId
required
string
Unique identifier (ID) of a column.


 
Responses 
204
Success - no content


401
Unauthorized


404
Not Found


delete/1/columns/{datasetSlug}/{columnId}
Request samples 
Response samples 
application/json
{
  • "error": "unknown API key - check your credentials"
}
➔ Next to Datasets