Hanzo
OpenapiO11y

Returns a rule's state-transition timeline for the posted query range, each…

Returns a rule's state-transition timeline for the posted query range, each entry carrying its related-logs or related-traces link.

POST /v1/o11y/rules/{id}/history/timeline

Addresshttps://api.hanzo.ai/v1/o11y/rules/{id}/history/timeline
MethodPOST
OperationGetRuleStateHistory
AuthAuthorization: Bearer $HANZO_API_KEY

Returns a rule's state-transition timeline for the posted query range, each entry carrying its related-logs or related-traces link. Viewer gate.

Request

18 fields, body application/json (required).

FieldInTypeRequiredDescription
idpathstringyes
endbodyinteger
filtersbodyo11y.FilterSet
filters.itemsbodyo11y.FilterItem[]
filters.items[].keybodyo11y.AttributeKey
filters.items[].key.dataTypebodystring
filters.items[].key.isColumnbodyboolean
filters.items[].key.isJSONbodyboolean
filters.items[].key.keybodystring
filters.items[].key.typebodystring
filters.items[].opbodystring
filters.items[].valuebodyobject
filters.opbodystring
limitbodyinteger
offsetbodyinteger
orderbodystring
startbodyinteger
statebodystring

Response

StatusBodyMeaning
200o11y.O11yRuleStateTimelineOutok

200 body — 18 fields.

FieldInTypeAlwaysDescription
databodyo11y.RuleStateTimeline
data.itemsbodyo11y.RuleStateHistory[]
data.items[].fingerprintbodyinteger
data.items[].labelsbodyany
data.items[].overallStatebodyanyOne of ["normal", "firing"]
data.items[].overallStateChangedbodyboolean
data.items[].relatedLogsLinkbodystring
data.items[].relatedTracesLinkbodystring
data.items[].ruleIDbodystring
data.items[].ruleNamebodystring
data.items[].statebodyanyOne of ["normal", "firing", "nodata", "muted"]
data.items[].stateChangedbodyboolean
data.items[].unixMillibodyinteger
data.items[].valuebodynumber
data.labelsbodyobject
data.labels.*bodystring[]
data.totalbodyinteger
statusbodystringStatus is "success".

Failure carries the platform error shape — see Errors.

Examples

hanzo o11y rules history timeline create <id>

O11y API · All Hanzo APIs · Interactive reference

How is this guide?

On this page