Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Honeycomb Calculated Fields API

Calculated Fields (also called Derived Columns) allow you to run queries based on the value of an expression that is calculated from the fields in an event.This API allows you to list, create, update, and delete Calculated Fields in a dataset or across a whole environment, paralleling the behavior of the Schema tab within a Dataset's or Environment's Settings UI.## AuthorizationThe API key must have the **Manage Queries and Columns** permission. Learn more about [API keys here](https://docs.honeycomb.io/configure/environments/manage-api-keys/).

Honeycomb Calculated Fields API is one of 21 APIs that Honeycomb publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Calculated Fields. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 5 operations across 2 paths, and defines 5 schemas. It is described by OpenAPI 3.1.0, at version 1.0.0.

Requests are made against 2 base URLs: https://api.honeycomb.io, https://api.eu1.honeycomb.io.

5 operations 2 paths 5 schemas 1 DELETE2 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0.0
Base URL
https://api.honeycomb.io
License
Resource Areas
1

Paths & Operations 5

Across 2 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Calculated Fields 5

Calculated Fields (also called Derived Columns) allow you to run queries based on the value of an expression that is calculated from the fields in an event. This API allows you to…

POST
/1/derived_columns/{datasetSlug}
Create a Calculated Field
createCalculatedField 1 param body → 201400401403404409429
GET
/1/derived_columns/{datasetSlug}
List all Calculated Fields
listCalculatedFields 2 params → 200400401404429
GET
/1/derived_columns/{datasetSlug}/{derivedColumnId}
Get a Calculated Field
getCalculatedField 2 params → 200400401404429
PUT
/1/derived_columns/{datasetSlug}/{derivedColumnId}
Update a Calculated Field
updateCalculatedField 2 params body → 200400401404409429
DELETE
/1/derived_columns/{datasetSlug}/{derivedColumnId}
Delete a Calculated Field
deleteCalculatedField 2 params → 204400401404409429

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are CalculatedField (6 properties), DetailedError (6 properties), Error (1 property), JSONAPIError (1 property). Each schema is shown below with its type and property counts.

CalculatedFieldList
array
DetailedError
object
An RFC7807 'Problem Detail' formatted error message.
6 properties 4 required
CalculatedField
object
6 properties 5 required
JSONAPIError
object
A JSONAPI-formatted error message.
1 property
Error
object
A legacy error, containing only a textual description.
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

honeycomb-io-calculated-fields-api-openapi.yml Raw ↑

Other APIs Honeycomb publishes across the network.

Honeycomb Auth API
Honeycomb Boards API
Honeycomb Burn Alerts API
Honeycomb Columns API
Honeycomb Dataset Definitions API
Honeycomb Datasets API
Honeycomb Environments API
Honeycomb Events API
Honeycomb Key Management API
Honeycomb Kinesis Events API
Honeycomb Marker Settings API
Honeycomb Markers API