Create analyze

Analyzes a query and extracts the metric names it reads and the columns it groups by.

POST /v1/o11y/query_filter/analyze

O11y → · All API references → · Get started →

Address	`https://api.hanzo.ai/v1/o11y/query_filter/analyze`
Method	`POST`
Operation	`post_o11y_query_filter_analyze`
Auth	`Authorization: Bearer $HANZO_API_KEY`

Analyzes a query and extracts the metric names it reads and the columns it groups by.

Callers need the viewer role; the runtime's own gate enforces it.

Request

2 fields, body application/json (required).

Field	In	Type	Required	Description
`query`	body	string	yes	Query is the query text.
`queryType`	body	string	yes	QueryType says which language the query is in — promql or the datastore's SQL dialect.

Response

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

200 body — 6 fields.

Field	In	Type	Always	Description
`data`	body	o11y.O11yQueryFilterAnalysis	—
`data.groups`	body	o11y.O11yColumnInfo[]	—	Groups are the columns the query groups by.
`data.groups[].columnAlias`	body	string	—	Alias is the column's alias in the query, when it has one.
`data.groups[].columnName`	body	string	—	Name is the column's name.
`data.metricNames`	body	string[]	—	MetricNames are the metrics the query reads.
`status`	body	string	—	Status is "success".

Failure carries the platform error shape — see Errors.

Examples

CLI

SDK

HTTP

MCP

hanzo o11y query_filter analyze \
  --query <query> \
  --query-type <queryType>

.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.postO11yQueryFilterAnalyze({ query: "<query>", queryType: "<queryType>" });

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).post_o11y_query_filter_analyze(query="<query>", query_type="<queryType>")

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

resp, _, err := client.O11yAPI.PostO11yQueryFilterAnalyze(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::post_o11y_query_filter_analyze(&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).postO11yQueryFilterAnalyze();

curl -X POST https://api.hanzo.ai/v1/o11y/query_filter/analyze \
  -H "Authorization: Bearer $HANZO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
       "query": "<query>",
       "queryType": "<queryType>"
     }'

MCP reaches o11y through the o11y tool, which names its 307 operations with its own verbs — this one among them, under a name only MCP 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": "list_o11y_autocomplete_aggregate_attributes"
         }
       }
     }'

O11y API · All Hanzo APIs · Interactive reference

Was this page useful?

PreviousList pvcs NextCreate format