Hanzo
OpenapiO11y

Returns the values one telemetry field has taken — string, bool, number and…

Returns the values one telemetry field has taken — string, bool, number and related values — and whether the value list is complete.

GET /v1/o11y/fields/values

Addresshttps://api.hanzo.ai/v1/o11y/fields/values
MethodGET
Operationget_o11y_fields_values
AuthAuthorization: Bearer $HANZO_API_KEY

Returns the values one telemetry field has taken — string, bool, number and related values — and whether the value list is complete.

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

Request

12 fields.

FieldInTypeRequiredDescription
signalquerystringSignal is the telemetry to read the field of — traces, logs or metrics.
sourcequerystringSource narrows the field to one source within the signal.
limitqueryintegerLimit caps how many values 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 field to one context.
fieldDataTypequerystringFieldDataType narrows the field to one data type.
metricNamequerystringMetricName narrows the field to one metric.
metricNamespacequerystringMetricNamespace narrows the field to one metric namespace.
searchTextquerystringSearchText narrows the values to those containing it.
namequerystringName is the field whose values to read.
existingQueryquerystringExistingQuery is the query the field appears in, so related values can be suggested for it.

Response

StatusBodyMeaning
200o11y.O11yFieldValuesOutok

200 body — 8 fields.

FieldInTypeAlwaysDescription
databodyo11y.GettableFieldValues
data.completebodyboolean
data.valuesbodyo11y.TelemetryFieldValues
data.values.boolValuesbodyboolean[]
data.values.numberValuesbodynumber[]
data.values.relatedValuesbodystring[]
data.values.stringValuesbodystring[]
statusbodystringStatus is "success".

Failure carries the platform error shape — see Errors.

Examples

hanzo o11y fields values

O11y API · All Hanzo APIs · Interactive reference

How is this guide?

On this page