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
| Address | https://api.hanzo.ai/v1/o11y/rules/{id}/history/timeline |
| Method | GET |
| Operation | GetRuleHistoryTimeline |
| Auth | Authorization: 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.
| Field | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | yes | |
start | query | integer | — | Start is the window start, unix milliseconds. |
end | query | integer | — | End is the window end, unix milliseconds. |
state | query | string | — | State keeps only entries in one alert state, e.g. |
filterExpression | query | string | — | FilterExpression narrows entries to those whose labels match it. |
limit | query | integer | — | Limit caps how many entries come back. |
order | query | string | — | Order sorts by time, asc or desc. |
cursor | query | string | — | Cursor resumes a previous page; opaque, returned as nextCursor. |
Response
| Status | Body | Meaning |
|---|---|---|
200 | o11y.O11yRuleHistoryTimelineOut | ok |
200 body — 23 fields.
| Field | In | Type | Always | Description |
|---|---|---|---|---|
data | body | o11y.GettableRuleStateTimeline | — | |
data.items | body | o11y.GettableRuleStateHistory[] | — | |
data.items[].fingerprint | body | integer | — | |
data.items[].labels | body | o11y.Label[] | — | |
data.items[].labels[].key | body | o11y.TelemetryFieldKey | — | |
data.items[].labels[].key.description | body | string | — | |
data.items[].labels[].key.fieldContext | body | any | — | |
data.items[].labels[].key.fieldDataType | body | any | — | |
data.items[].labels[].key.name | body | string | yes | |
data.items[].labels[].key.signal | body | any | — | |
data.items[].labels[].key.unit | body | string | — | |
data.items[].labels[].value | body | object | — | |
data.items[].overallState | body | any | — | |
data.items[].overallStateChanged | body | boolean | — | |
data.items[].ruleId | body | string | — | |
data.items[].ruleName | body | string | — | |
data.items[].state | body | any | — | |
data.items[].stateChanged | body | boolean | — | |
data.items[].unixMilli | body | integer | — | |
data.items[].value | body | number | — | |
data.nextCursor | body | string | — | |
data.total | body | integer | — | |
status | body | string | — | Status is "success". |
Failure carries the platform error shape — see Errors.
Examples
hanzo o11y rules history timeline get <id>import { Configuration, O11yApi } from 'hanzoai';
const api = new O11yApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.getRuleHistoryTimeline({ id: 'id' });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_history_timeline(id='id')cfg := cloud.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := cloud.NewAPIClient(cfg)
resp, _, err := client.O11yAPI.GetRuleHistoryTimeline(context.Background()).Execute()
if err != nil {
return err
}use hanzo_cloud::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_history_timeline(&cfg, Default::default()).await?;import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.O11yApi;
ApiClient client = new ApiClient();
client.setRequestInterceptor(b -> b.header("Authorization", "Bearer " + System.getenv("HANZO_API_KEY")));
var result = new O11yApi(client).getRuleHistoryTimeline();curl https://api.hanzo.ai/v1/o11y/rules/<id>/history/timeline \
-H "Authorization: Bearer $HANZO_API_KEY"Tool o11y, op GetRuleHistoryTimeline — 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": "GetRuleHistoryTimeline",
"input": {
"id": "<id>"
}
}
}
}'How is this guide?