OpenapiO11y
Suggests attribute keys and example filter queries for the query builder,…
Suggests attribute keys and example filter queries for the query builder, seeded by what the org's own telemetry carries.
GET /v1/o11y/filter_suggestions
| Address | https://api.hanzo.ai/v1/o11y/filter_suggestions |
| Method | GET |
| Operation | get_o11y_filter_suggestions |
| Auth | Authorization: Bearer $HANZO_API_KEY |
Suggests attribute keys and example filter queries for the query builder, seeded by what the org's own telemetry carries. Only the logs data source is supported today.
Callers need the viewer role; the runtime's own gate enforces it.
Request
5 fields.
| Field | In | Type | Required | Description |
|---|---|---|---|---|
dataSource | query | string | yes | DataSource is the signal suggestions are drawn from; only logs is supported today. |
searchText | query | string | — | SearchText narrows attribute suggestions to keys containing it. |
existingFilter | query | string | — | ExistingFilter is the current filter set, JSON base64url-encoded, so example queries build on it rather than repeat it. |
attributesLimit | query | integer | — | AttributesLimit caps how many attribute keys come back. |
examplesLimit | query | integer | — | ExamplesLimit caps how many example queries come back. |
Response
| Status | Body | Meaning |
|---|---|---|
200 | o11y.O11yFilterSuggestionsOut | ok |
200 body — 19 fields.
| Field | In | Type | Always | Description |
|---|---|---|---|---|
data | body | o11y.O11yFilterSuggestions | — | |
data.attributes | body | o11y.O11yAttributeKey[] | — | Attributes are the suggested attribute keys. |
data.attributes[].dataType | body | string | — | DataType is the attribute's value type — string, int64, float64 or bool. |
data.attributes[].isColumn | body | boolean | — | IsColumn marks an attribute materialized as its own column. |
data.attributes[].isJSON | body | boolean | — | IsJSON marks an attribute extracted from a JSON body. |
data.attributes[].key | body | string | — | Key is the attribute's name. |
data.attributes[].type | body | string | — | Type says where the attribute lives: tag or resource. |
data.example_queries | body | o11y.O11yFilterSet[] | — | ExampleQueries are ready-to-run filter sets. |
data.example_queries[].items | body | o11y.O11yFilterItem[] | — | Items are the conditions. |
data.example_queries[].items[].key | body | o11y.O11yAttributeKey | — | |
data.example_queries[].items[].key.dataType | body | string | — | DataType is the attribute's value type — string, int64, float64 or bool. |
data.example_queries[].items[].key.isColumn | body | boolean | — | IsColumn marks an attribute materialized as its own column. |
data.example_queries[].items[].key.isJSON | body | boolean | — | IsJSON marks an attribute extracted from a JSON body. |
data.example_queries[].items[].key.key | body | string | — | Key is the attribute's name. |
data.example_queries[].items[].key.type | body | string | — | Type says where the attribute lives: tag or resource. |
data.example_queries[].items[].op | body | string | — | Operator is the comparison, e.g. |
data.example_queries[].items[].value | body | object | — | Value is what it is tested against; its type follows the attribute's. |
data.example_queries[].op | body | string | — | Operator combines the items — AND or OR. |
status | body | string | — | Status is "success". |
Failure carries the platform error shape — see Errors.
Examples
hanzo o11y filter_suggestions --data-source <data-source>import { Configuration, O11yApi } from 'hanzoai';
const api = new O11yApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.getO11yFilterSuggestions({ dataSource: 'dataSource' });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_o11y_filter_suggestions(data_source='dataSource')cfg := cloud.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := cloud.NewAPIClient(cfg)
resp, _, err := client.O11yAPI.GetO11yFilterSuggestions(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_o11y_filter_suggestions(&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).getO11yFilterSuggestions();curl https://api.hanzo.ai/v1/o11y/filter_suggestions?dataSource=%3CdataSource%3E \
-H "Authorization: Bearer $HANZO_API_KEY"The door reaches o11y through the o11y tool, which names its 340 operations with its own verbs — this one among them, under a name only the door declares. describe explains any of them:
curl -X POST https://api.hanzo.ai/v1/mcp \
-H "Content-Type: application/json" \
-d '{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "describe",
"arguments": {
"op": "get_o11y_alert_last"
}
}
}'How is this guide?