Get dataset field - Automate.ax

axiom.getDatasetField retrieves one dataset field definition. The result includes its type, visibility, description, and unit.

automations/axiom-get-dataset-field.automation.ts

import { automation, onHttpRequest } from "automate.ax"
import { axiom } from "automate.ax/axiom"

export default automation("Get dataset field", () => {
  onHttpRequest({ scope: "automation" })
  axiom.getDatasetField({
    datasetName: "production",
    fieldName: "service.name",
  })
})

Inputs

datasetName selects an events, logs, or traces dataset by name or ID. fieldName selects one non-empty field name.

Output

Returns the field’s name and type, with hidden, description, and unit when configured.

Permission and failures

The API token needs the organization-level datasets|read capability and access to the target dataset. Axiom returns an error when the dataset or field is missing or inaccessible.