List filter keys

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
startUnixMilliqueryinteger—StartUnixMilli is the window start, unix milliseconds.
endUnixMilliqueryinteger—EndUnixMilli is the window end, unix milliseconds.
searchTextquerystring—SearchText narrows the keys to those containing it.
limitqueryinteger—Limit caps how many keys come back.

Response

StatusBodyMeaning
200o11y.O11yRuleHistoryFilterKeysOutok
202Approvalheld for approval
defaultproblem-detailsrefused

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—
statusbodystring—Status is "success".

Failure carries the platform error shape — see Errors.

Examples

hanzo o11y rules history filter_keys <id>
import { Configuration, O11yApi } from 'hanzoai';

const api = new O11yApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.getRuleHistoryFilterKeys({ 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_filter_keys(id='id')
cfg := hanzoai.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := hanzoai.NewAPIClient(cfg)

resp, _, err := client.O11yAPI.GetRuleHistoryFilterKeys(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_history_filter_keys(&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).getRuleHistoryFilterKeys();
curl https://api.hanzo.ai/v1/o11y/rules/<id>/history/filter_keys \
  -H "Authorization: Bearer $HANZO_API_KEY"

Tool o11y, op GetRuleHistoryFilterKeys — 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": "GetRuleHistoryFilterKeys",
           "input": {
             "id": "<id>"
           }
         }
       }
     }'

O11y API · All Hanzo APIs · Interactive reference

Was this page useful?