Create timeline

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

O11y → · All API references → · Get started →

Address	`https://api.hanzo.ai/v1/o11y/rules/{id}/history/timeline`
Method	`POST`
Operation	`GetRuleStateHistory`
Auth	`Authorization: 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).

Field	In	Type	Required
`id`	path	string	yes
`end`	body	integer (int64)	—
`filters`	body	o11y.FilterSet	—
`filters.items`	body	o11y.FilterItem[]	—
`filters.items[].key`	body	o11y.AttributeKey	—
`filters.items[].key.dataType`	body	string	—
`filters.items[].key.isColumn`	body	boolean	—
`filters.items[].key.isJSON`	body	boolean	—
`filters.items[].key.key`	body	string	—
`filters.items[].key.type`	body	string	—
`filters.items[].op`	body	string	—
`filters.items[].value`	body	any	—
`filters.op`	body	string	—
`limit`	body	integer (int64)	—
`offset`	body	integer (int64)	—
`order`	body	string	—
`start`	body	integer (int64)	—
`state`	body	string	—

Response

Status	Body	Meaning
`200`	o11y.O11yRuleStateTimelineOut	ok
`202`	Approval	held for approval
`default`	problem-details	refused

200 body — 18 fields.

Field	In	Type	Always	Description
`data`	body	o11y.RuleStateTimeline	—
`data.items`	body	o11y.RuleStateHistory[]	—
`data.items[].fingerprint`	body	integer (uint64)	—
`data.items[].labels`	body	any	—
`data.items[].overallState`	body	any	—	One of ["normal", "firing"]
`data.items[].overallStateChanged`	body	boolean	—
`data.items[].relatedLogsLink`	body	string	—
`data.items[].relatedTracesLink`	body	string	—
`data.items[].ruleID`	body	string	—
`data.items[].ruleName`	body	string	—
`data.items[].state`	body	any	—	One of ["normal", "firing", "nodata", "muted"]
`data.items[].stateChanged`	body	boolean	—
`data.items[].unixMilli`	body	integer (int64)	—
`data.items[].value`	body	number (double)	—
`data.labels`	body	object	—
`data.labels.*`	body	string[]	—
`data.total`	body	integer (uint64)	—
`status`	body	string	—	Status is "success".

Failure carries the platform error shape — see Errors.

Examples

CLI

SDK

HTTP

MCP

hanzo o11y rules history timeline create <id>

.ts

.py

.go

.rs

.java

import { Configuration, O11yApi } from 'hanzoai';

const api = new O11yApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.getRuleStateHistory({ id: 'id', end: 0, filters: {"items":[{"key":{"dataType":null,"isColumn":null,"isJSON":null,"key":null},"op":"<op>","value":"<value>"}],"op":"<op>"} });

from hanzoai.cloud import ApiClient, Configuration
from hanzoai.cloud.api import O11yApi

client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = O11yApi(client).get_rule_state_history(id='id', end=0, filters={"items":[{"key":{"dataType":null,"isColumn":null,"isJSON":null,"key":null},"op":"<op>","value":"<value>"}],"op":"<op>"})

cfg := hanzoai.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := hanzoai.NewAPIClient(cfg)

resp, _, err := client.O11yAPI.GetRuleStateHistory(context.Background()).Execute()
if err != nil {
	return err
}

use hanzo_client::apis::{configuration::Configuration, o11y_api};

let mut cfg = Configuration::new();
cfg.bearer_access_token = std::env::var("HANZO_API_KEY").ok();

let result = o11y_api::get_rule_state_history(&cfg, Default::default()).await?;

import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.O11yApi;

ApiClient client = new ApiClient();
client.setBearerToken(System.getenv("HANZO_API_KEY"));

var result = new O11yApi(client).getRuleStateHistory();

curl -X POST https://api.hanzo.ai/v1/o11y/rules/<id>/history/timeline \
  -H "Authorization: Bearer $HANZO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
       "end": 0,
       "filters": {
         "items": [
           {
             "key": {
               "dataType": null,
               "isColumn": null,
               "isJSON": null,
               "key": null
             },
             "op": "<op>",
             "value": "<value>"
           }
         ],
         "op": "<op>"
       }
     }'

Tool o11y, op GetRuleStateHistory — POST the JSON-RPC envelope to https://api.hanzo.ai/v1/mcp.

curl -X POST https://api.hanzo.ai/v1/mcp \
  -H "Authorization: Bearer $HANZO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
       "jsonrpc": "2.0",
       "id": 1,
       "method": "tools/call",
       "params": {
         "name": "o11y",
         "arguments": {
           "op": "GetRuleStateHistory",
           "input": {
             "id": "<id>",
             "end": 0,
             "filters": {
               "items": [
                 {
                   "key": {
                     "dataType": null,
                     "isColumn": null,
                     "isJSON": null,
                     "key": null
                   },
                   "op": "<op>",
                   "value": "<value>"
                 }
               ],
               "op": "<op>"
             }
           }
         }
       }
     }'

O11y API · All Hanzo APIs · Interactive reference

Was this page useful?

PreviousList top contributors NextCreate top contributors