Hanzo
OpenapiO11y

Returns the distinct label keys present in a rule's history entries over the…

Returns the distinct label keys present in a rule's history entries over the selected range, for building history filters.

GET /v1/o11y/rules/{id}/history/filter_keys

Addresshttps://api.hanzo.ai/v1/o11y/rules/{id}/history/filter_keys
MethodGET
OperationGetRuleHistoryFilterKeys
AuthAuthorization: Bearer $HANZO_API_KEY

Returns the distinct label keys present in a rule's history entries over the selected range, for building history filters. Viewer gate.

Request

5 fields.

FieldInTypeRequiredDescription
idpathstringyes
startUnixMilliqueryintegerStartUnixMilli is the window start, unix milliseconds.
endUnixMilliqueryintegerEndUnixMilli is the window end, unix milliseconds.
searchTextquerystringSearchText narrows the keys to those containing it.
limitqueryintegerLimit caps how many keys come back.

Response

StatusBodyMeaning
200o11y.O11yRuleHistoryFilterKeysOutok

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 rules history filter_keys <id>

O11y API · All Hanzo APIs · Interactive reference

How is this guide?

On this page