HOhoneycomb
Calculated Fields

Create a Calculated Field

Create a Calculated Field (also called a Derived Column). Calculated Fields allow you to run queries based on the value of an expression that is calculated from the fields in an event.

post/1/derived_columns/{datasetSlug}

Request

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

Request body

idstring required

Unique identifier (ID), returned in response bodies.

aliasstring required

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

expressionstring 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.

descriptionstring

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

created_atstring required

ISO8601 formatted time when the field was created.

updated_atstring required

ISO8601 formatted time when the field was updated.

Response

Success

idstring required

Unique identifier (ID), returned in response bodies.

aliasstring required

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

expressionstring 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.

descriptionstring

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

created_atstring required

ISO8601 formatted time when the field was created.

updated_atstring required

ISO8601 formatted time when the field was updated.

Changes

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