Query variables

Evaluates a dashboard variable query and returns the values the variable may take.

POST /v1/o11y/variables/query

Addresshttps://api.hanzo.ai/v1/o11y/variables/query
MethodPOST
Operationpost_o11y_variables_query
AuthAuthorization: Bearer $HANZO_API_KEY

Evaluates a dashboard variable query and returns the values the variable may take.

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

Request

3 fields, body application/json (required).

FieldInTypeRequiredDescription
querybodystringyesQuery is the variable query to evaluate.
variablesbodyobject—Variables are the current values of the other dashboard variables, for queries that reference them.
variables.*bodyany—

Response

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

200 body — 3 fields.

FieldInTypeAlwaysDescription
databodyo11y.O11yDashboardVarValues—
data.variableValuesbodyany[]—VariableValues are the values, in the order the query produced them.
statusbodystring—Status is "success".

Failure carries the platform error shape — see Errors.

Examples

hanzo o11y variables query --query <query>
import { Configuration, O11yApi } from 'hanzoai';

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

resp, _, err := client.O11yAPI.PostO11yVariablesQuery(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_variables_query(&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).postO11yVariablesQuery();
curl -X POST https://api.hanzo.ai/v1/o11y/variables/query \
  -H "Authorization: Bearer $HANZO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
       "query": "<query>"
     }'

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?