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

Manage calculated fields (derived columns) that compute values from expressions applied to event fields.

honeycomb Calculated Fields API is one of 22 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 3 schemas. It is described by OpenAPI 3.1.0, at version 1.0.

Requests are made against a single base URL, https://api.honeycomb.io.

5 operations 2 paths 3 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
Base URL
https://api.honeycomb.io
Authentication
API Key
Terms of Service
Resource Areas
1

Authentication & Security 1

honeycomb Calculated Fields API declares 1 security scheme for authenticating requests. An API key is passed in the header as X-Honeycomb-Team (ApiKeyAuth). By default, every request must be authenticated.

  • ApiKeyAuth — Honeycomb Configuration API key. Must have appropriate permissions for the endpoint being called.

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

Manage calculated fields (derived columns) that compute values from expressions applied to event fields.

GET
/1/calculated_fields/{datasetSlug}
List calculated fields
listCalculatedFields 1 param → 200401
POST
/1/calculated_fields/{datasetSlug}
Create a calculated field
createCalculatedField 1 param body → 201401
GET
/1/calculated_fields/{datasetSlug}/{calculatedFieldId}
Get a calculated field
getCalculatedField 2 params → 200401404
PUT
/1/calculated_fields/{datasetSlug}/{calculatedFieldId}
Update a calculated field
updateCalculatedField 2 params body → 200401404
DELETE
/1/calculated_fields/{datasetSlug}/{calculatedFieldId}
Delete a calculated field
deleteCalculatedField 2 params → 204401404

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are CalculatedField (6 properties), CalculatedFieldCreateRequest (3 properties), CalculatedFieldUpdateRequest (2 properties). Each schema is shown below with its type and property counts.

CalculatedFieldCreateRequest
object
3 properties 2 required
CalculatedField
object
6 properties
CalculatedFieldUpdateRequest
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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

Other APIs honeycomb publishes across the network.

Honeycomb Events API
Honeycomb Queries API
Honeycomb SLOs API
Honeycomb Datasets API
Honeycomb Boards API
Honeycomb Markers API
Honeycomb Triggers API
Honeycomb Environments API
honeycomb Auth API
honeycomb Burn Alerts API
honeycomb Columns API
honeycomb Dataset Definitions API