Hanzo
OpenapiO11y

Returns the telemetry field keys matching the selector — the signal's fields…

Returns the telemetry field keys matching the selector — the signal's fields grouped by name, and whether the catalog is complete.

GET /v1/o11y/fields/keys

Addresshttps://api.hanzo.ai/v1/o11y/fields/keys
MethodGET
Operationget_o11y_fields_keys
AuthAuthorization: Bearer $HANZO_API_KEY

Returns the telemetry field keys matching the selector — the signal's fields grouped by name, and whether the catalog is complete.

Callers need the viewer role; the runtime's own gate enforces it.

Request

10 fields.

FieldInTypeRequiredDescription
signalquerystringSignal is the telemetry to read the fields of — traces, logs or metrics.
sourcequerystringSource narrows the fields to one source within the signal.
limitqueryintegerLimit caps how many keys come back.
startUnixMilliqueryintegerStartUnixMilli is the window start as a unix millisecond epoch.
endUnixMilliqueryintegerEndUnixMilli is the window end as a unix millisecond epoch.
fieldContextquerystringFieldContext narrows the keys to one context — resource, scope, attribute, span, log or metric.
fieldDataTypequerystringFieldDataType narrows the keys to one data type.
metricNamequerystringMetricName narrows the keys to those on one metric.
metricNamespacequerystringMetricNamespace narrows the keys to one metric namespace.
searchTextquerystringSearchText narrows the keys to those containing it.

Response

StatusBodyMeaning
200o11y.O11yFieldKeysOutok

200 body — 11 fields.

FieldInTypeAlwaysDescription
databodyo11y.GettableFieldKeys
data.completebodyboolean
data.keysbodyobject
data.keys.*bodyo11y.TelemetryFieldKey[]
data.keys.*[].descriptionbodystring
data.keys.*[].fieldContextbodyany
data.keys.*[].fieldDataTypebodyany
data.keys.*[].namebodystringyes
data.keys.*[].signalbodyany
data.keys.*[].unitbodystring
statusbodystringStatus is "success".

Failure carries the platform error shape — see Errors.

Examples

hanzo o11y fields keys

O11y API · All Hanzo APIs · Interactive reference

How is this guide?

On this page