Create format

Parses a builder query and echoes it back normalized to the v3 shape — the endpoint the UI uses to canonicalize a query without running it.

POST /v1/o11y/query_range/format

O11y → · All API references → · Get started →

Address	`https://api.hanzo.ai/v1/o11y/query_range/format`
Method	`POST`
Operation	`post_o11y_query_range_format`
Auth	`Authorization: Bearer $HANZO_API_KEY`

Parses a builder query and echoes it back normalized to the v3 shape — the endpoint the UI uses to canonicalize a query without running it.

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

Request

87 fields, body application/json (required).

Field	In	Type	Required	Description
`compositeQuery`	body	o11y.v3.CompositeQuery	—
`compositeQuery.builderQueries`	body	object	—
`compositeQuery.builderQueries.*`	body	o11y.BuilderQuery	—
`compositeQuery.builderQueries.*.IsAnomaly`	body	boolean	—
`compositeQuery.builderQueries.*.QueriesUsedInFormula`	body	string[]	—
`compositeQuery.builderQueries.*.ShiftBy`	body	integer (int64)	—
`compositeQuery.builderQueries.*.aggregateAttribute`	body	o11y.AttributeKey	—
`compositeQuery.builderQueries.*.aggregateAttribute.dataType`	body	string	—
`compositeQuery.builderQueries.*.aggregateAttribute.isColumn`	body	boolean	—
`compositeQuery.builderQueries.*.aggregateAttribute.isJSON`	body	boolean	—
`compositeQuery.builderQueries.*.aggregateAttribute.key`	body	string	—
`compositeQuery.builderQueries.*.aggregateAttribute.type`	body	string	—
`compositeQuery.builderQueries.*.aggregateOperator`	body	string	—
`compositeQuery.builderQueries.*.dataSource`	body	string	—
`compositeQuery.builderQueries.*.disabled`	body	boolean	—
`compositeQuery.builderQueries.*.expression`	body	string	—
`compositeQuery.builderQueries.*.filters`	body	o11y.FilterSet	—
`compositeQuery.builderQueries.*.filters.items`	body	o11y.FilterItem[]	—
`compositeQuery.builderQueries.*.filters.items[].key`	body	o11y.AttributeKey	—
`compositeQuery.builderQueries.*.filters.items[].key.dataType`	body	string	—
`compositeQuery.builderQueries.*.filters.items[].key.isColumn`	body	boolean	—
`compositeQuery.builderQueries.*.filters.items[].key.isJSON`	body	boolean	—
`compositeQuery.builderQueries.*.filters.items[].key.key`	body	string	—
`compositeQuery.builderQueries.*.filters.items[].key.type`	body	string	—
`compositeQuery.builderQueries.*.filters.items[].op`	body	string	—
`compositeQuery.builderQueries.*.filters.items[].value`	body	any	—
`compositeQuery.builderQueries.*.filters.op`	body	string	—
`compositeQuery.builderQueries.*.functions`	body	o11y.Function[]	—
`compositeQuery.builderQueries.*.functions[].args`	body	any[]	—
`compositeQuery.builderQueries.*.functions[].name`	body	string	—
`compositeQuery.builderQueries.*.functions[].namedArgs`	body	object	—
`compositeQuery.builderQueries..functions[].namedArgs.`	body	any	—
`compositeQuery.builderQueries.*.groupBy`	body	o11y.AttributeKey[]	—
`compositeQuery.builderQueries.*.groupBy[].dataType`	body	string	—
`compositeQuery.builderQueries.*.groupBy[].isColumn`	body	boolean	—
`compositeQuery.builderQueries.*.groupBy[].isJSON`	body	boolean	—
`compositeQuery.builderQueries.*.groupBy[].key`	body	string	—
`compositeQuery.builderQueries.*.groupBy[].type`	body	string	—
`compositeQuery.builderQueries.*.having`	body	o11y.Having[]	—
`compositeQuery.builderQueries.*.having[].columnName`	body	string	—
`compositeQuery.builderQueries.*.having[].op`	body	string	—
`compositeQuery.builderQueries.*.having[].value`	body	any	—
`compositeQuery.builderQueries.*.legend`	body	string	—
`compositeQuery.builderQueries.*.limit`	body	integer (uint64)	—
`compositeQuery.builderQueries.*.offset`	body	integer (uint64)	—
`compositeQuery.builderQueries.*.orderBy`	body	o11y.OrderBy[]	—
`compositeQuery.builderQueries.*.orderBy[].columnName`	body	string	—
`compositeQuery.builderQueries.*.orderBy[].order`	body	string	—
`compositeQuery.builderQueries.*.pageSize`	body	integer (uint64)	—
`compositeQuery.builderQueries.*.queryName`	body	string	—
`compositeQuery.builderQueries.*.reduceTo`	body	string	—
`compositeQuery.builderQueries.*.selectColumns`	body	o11y.AttributeKey[]	—
`compositeQuery.builderQueries.*.selectColumns[].dataType`	body	string	—
`compositeQuery.builderQueries.*.selectColumns[].isColumn`	body	boolean	—
`compositeQuery.builderQueries.*.selectColumns[].isJSON`	body	boolean	—
`compositeQuery.builderQueries.*.selectColumns[].key`	body	string	—
`compositeQuery.builderQueries.*.selectColumns[].type`	body	string	—
`compositeQuery.builderQueries.*.seriesAggregation`	body	string	—
`compositeQuery.builderQueries.*.spaceAggregation`	body	string	—
`compositeQuery.builderQueries.*.stepInterval`	body	integer (int64)	—
`compositeQuery.builderQueries.*.temporality`	body	string	—
`compositeQuery.builderQueries.*.timeAggregation`	body	string	—
`compositeQuery.chQueries`	body	object	—
`compositeQuery.chQueries.*`	body	o11y.DatastoreQuery	—
`compositeQuery.chQueries.*.disabled`	body	boolean	—
`compositeQuery.chQueries.*.legend`	body	string	—
`compositeQuery.chQueries.*.query`	body	string	—
`compositeQuery.fillGaps`	body	boolean	—	FillGaps is used to fill the gaps in the time series data
`compositeQuery.panelType`	body	string	—
`compositeQuery.promQueries`	body	object	—
`compositeQuery.promQueries.*`	body	o11y.PromQuery	—
`compositeQuery.promQueries.*.disabled`	body	boolean	—
`compositeQuery.promQueries.*.legend`	body	string	—
`compositeQuery.promQueries.*.query`	body	string	—
`compositeQuery.promQueries.*.stats`	body	string	—
`compositeQuery.queries`	body	o11y.QueryEnvelope[]	—
`compositeQuery.queries[].spec`	body	any	—	Spec is the deferred decoding of the query if any.
`compositeQuery.queries[].type`	body	any	—	Type is the type of the query.
`compositeQuery.queryType`	body	string	—
`compositeQuery.unit`	body	string	—	Unit for the time series data shown in the graph This is used in alerts to format the value and threshold
`end`	body	integer (int64)	—
`formatForWeb`	body	boolean	—
`noCache`	body	boolean	—
`start`	body	integer (int64)	—
`step`	body	integer (int64)	—	step is in seconds; used for prometheus queries
`variables`	body	object	—
`variables.*`	body	any	—

Response

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

200 body — 2 fields.

Field	In	Type	Always	Description
`data`	body	any	—	Data is the query, normalized to the v3 shape.
`status`	body	string	—	Status is "success".

Failure carries the platform error shape — see Errors.

Examples

CLI

SDK

HTTP

MCP

hanzo o11y query_range format

.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.postO11yQueryRangeFormat({ compositeQuery: {"builderQueries":{},"chQueries":{},"fillGaps":false,"panelType":"<panelType>"}, end: 0 });

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_range_format(composite_query={"builderQueries":{},"chQueries":{},"fillGaps":false,"panelType":"<panelType>"}, end=0)

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

resp, _, err := client.O11yAPI.PostO11yQueryRangeFormat(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_range_format(&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).postO11yQueryRangeFormat();

curl -X POST https://api.hanzo.ai/v1/o11y/query_range/format \
  -H "Authorization: Bearer $HANZO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
       "compositeQuery": {
         "builderQueries": {},
         "chQueries": {},
         "fillGaps": false,
         "panelType": "<panelType>"
       },
       "end": 0
     }'

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?

PreviousCreate analyze NextPreview query range