OpenapiO11y
Evaluates one instant PromQL query against the org's metrics and returns the…
Evaluates one instant PromQL query against the org's metrics and returns the result at a single point in time.
GET /v1/o11y/query
| Address | https://api.hanzo.ai/v1/o11y/query |
| Method | GET |
| Operation | get_o11y_query |
| Auth | Authorization: Bearer $HANZO_API_KEY |
Evaluates one instant PromQL query against the org's metrics and returns the result at a single point in time.
The result is polymorphic by PromQL's own contract — a matrix, vector, scalar or string, discriminated by resultType — so it is carried verbatim rather than forced into one of its shapes.
Callers need the viewer role; the runtime's own gate enforces it.
Request
4 fields.
| Field | In | Type | Required | Description |
|---|---|---|---|---|
query | query | string | yes | Query is the PromQL expression to evaluate. |
time | query | string | — | Time is the evaluation timestamp — epoch seconds or RFC3339. |
stats | query | string | — | Stats set to any non-empty value includes query statistics in the answer. |
timeout | query | string | — | Timeout caps evaluation time, as a duration in seconds. |
Response
| Status | Body | Meaning |
|---|---|---|
200 | o11y.O11yPromQueryOut | ok |
200 body — 5 fields.
| Field | In | Type | Always | Description |
|---|---|---|---|---|
data | body | o11y.O11yPromResult | — | |
data.result | body | any | — | Result is the result in PromQL's own wire shape for ResultType, carried verbatim. |
data.resultType | body | string | — | ResultType discriminates Result: matrix, vector, scalar or string. |
data.stats | body | any | — | Stats holds query statistics when the caller asked for them. |
status | body | string | — | Status is "success". |
Failure carries the platform error shape — see Errors.
Examples
hanzo o11y query --query <query>import { Configuration, O11yApi } from 'hanzoai';
const api = new O11yApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.getO11yQuery({ 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).get_o11y_query(query='query')cfg := cloud.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := cloud.NewAPIClient(cfg)
resp, _, err := client.O11yAPI.GetO11yQuery(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_query(&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).getO11yQuery();curl https://api.hanzo.ai/v1/o11y/query?query=%3Cquery%3E \
-H "Authorization: Bearer $HANZO_API_KEY"Tool o11y, op get_o11y_query — 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": "get_o11y_query",
"input": {
"query": "<query>"
}
}
}
}'How is this guide?