Skip to main content
POST
/
1
/
derived_columns
/
{datasetSlug}
Create a Calculated Field
curl --request POST \
  --url https://api.honeycomb.io/1/derived_columns/{datasetSlug} \
  --header 'Content-Type: application/json' \
  --header 'X-Honeycomb-Team: <api-key>' \
  --data '
{
  "alias": "<string>",
  "expression": "<string>",
  "description": ""
}
'
{
  "id": "yUheCUmgZ8p",
  "alias": "one",
  "description": "just one",
  "expression": "INT(1)",
  "created_at": "2022-07-26T22:38:04Z",
  "updated_at": "2022-11-16T17:34:01Z"
}

Documentation Index

Fetch the complete documentation index at: https://docs.honeycomb.io/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
X-Honeycomb-Team
string
header
required

A Honeycomb Configuration Key is required to use this API. A Configuration Key can be found in the API Keys section of the environment configuration, which can be found under Environment Settings -> API Keys -> Configuration tab. Check out our documentation to find your API Keys.

More information can be found in Manage Environments.

Path Parameters

​
datasetSlug
string
required

The dataset slug or use __all__ for endpoints that support environment-wide operations.

Body

application/json
​
alias
string
required

The human-readable name of the Calculated Field (also called Derived Column), as it will be referenced when building queries.

Required string length: 1 - 255
​
expression
string
required

The expression to evaluate to construct this Calculated Field's value. (Calculated Field is also called Derived Column.) Refer to the Calculated Field Reference.

Required string length: 1 - 4095
​
description
string
default:""

A human-readable description for the Calculated Field that displays in the UI.

Maximum string length: 255

Response

Success

​
id
string
required
read-only

Unique identifier (ID), returned in response bodies.

​
alias
string
required

The human-readable name of the Calculated Field (also called Derived Column), as it will be referenced when building queries.

Required string length: 1 - 255
​
expression
string
required

The expression to evaluate to construct this Calculated Field's value. (Calculated Field is also called Derived Column.) Refer to the Calculated Field Reference.

Required string length: 1 - 4095
​
created_at
string
required
read-only

ISO8601 formatted time when the field was created.

​
updated_at
string
required
read-only

ISO8601 formatted time when the field was updated.

​
description
string
default:""

A human-readable description for the Calculated Field that displays in the UI.

Maximum string length: 255