Hanzo
OpenapiO11y

Returns paginated timeline entries for a rule's state transitions, filterable…

Returns paginated timeline entries for a rule's state transitions, filterable by state and a label expression, cursor-paginated.

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

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

Returns paginated timeline entries for a rule's state transitions, filterable by state and a label expression, cursor-paginated. Viewer gate.

Request

8 fields.

FieldInTypeRequiredDescription
idpathstringyes
startqueryintegerStart is the window start, unix milliseconds.
endqueryintegerEnd is the window end, unix milliseconds.
statequerystringState keeps only entries in one alert state, e.g.
filterExpressionquerystringFilterExpression narrows entries to those whose labels match it.
limitqueryintegerLimit caps how many entries come back.
orderquerystringOrder sorts by time, asc or desc.
cursorquerystringCursor resumes a previous page; opaque, returned as nextCursor.

Response

StatusBodyMeaning
200o11y.O11yRuleHistoryTimelineOutok

200 body — 23 fields.

FieldInTypeAlwaysDescription
databodyo11y.GettableRuleStateTimeline
data.itemsbodyo11y.GettableRuleStateHistory[]
data.items[].fingerprintbodyinteger
data.items[].labelsbodyo11y.Label[]
data.items[].labels[].keybodyo11y.TelemetryFieldKey
data.items[].labels[].key.descriptionbodystring
data.items[].labels[].key.fieldContextbodyany
data.items[].labels[].key.fieldDataTypebodyany
data.items[].labels[].key.namebodystringyes
data.items[].labels[].key.signalbodyany
data.items[].labels[].key.unitbodystring
data.items[].labels[].valuebodyobject
data.items[].overallStatebodyany
data.items[].overallStateChangedbodyboolean
data.items[].ruleIdbodystring
data.items[].ruleNamebodystring
data.items[].statebodyany
data.items[].stateChangedbodyboolean
data.items[].unixMillibodyinteger
data.items[].valuebodynumber
data.nextCursorbodystring
data.totalbodyinteger
statusbodystringStatus is "success".

Failure carries the platform error shape — see Errors.

Examples

hanzo o11y rules history timeline get <id>

O11y API · All Hanzo APIs · Interactive reference

How is this guide?

On this page