Preview query range

Validates a composite query and renders the Datastore statements it would run WITHOUT executing it — a dry run for agentic and tooling use.

POST /v1/o11y/query_range/preview

O11y → · All API references → · Get started →

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

Validates a composite query and renders the Datastore statements it would run WITHOUT executing it — a dry run for agentic and tooling use. verbose=false trades the rendered SQL and EXPLAIN for a lightweight per-query verdict.

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

Request

17 fields, body application/json (required).

Field	In	Type	Required	Description
`compositeQuery`	body	o11y.CompositeQuery	—
`compositeQuery.queries`	body	o11y.QueryEnvelope[]	—	Queries is the queries to use for the request.
`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.
`end`	body	integer (uint64)	—
`formatOptions`	body	o11y.FormatOptions	—
`formatOptions.fillGaps`	body	boolean	—
`formatOptions.formatTableResultForUI`	body	boolean	—
`noCache`	body	boolean	—
`requestType`	body	any	—
`schemaVersion`	body	string	—
`start`	body	integer (uint64)	—
`variables`	body	object	—
`variables.*`	body	o11y.VariableItem	—
`variables.*.type`	body	any	—
`variables.*.value`	body	any	—
`verbose`	body	string	—	Verbose selects the answer's depth.

Response

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

200 body — 2 fields.

Field	In	Type	Always	Description
`data`	body	any	—	Data holds one preview per query, keyed by query name — the rendered statements with optional EXPLAIN and granule analysis, or the per-query verdict.
`status`	body	string	—	Status is "success".

Failure carries the platform error shape — see Errors.

Examples

CLI

SDK

HTTP

MCP

hanzo o11y query_range preview

.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.postO11yQueryRangePreview({ compositeQuery: {"queries":[{"spec":"<spec>","type":"<type>"}]}, 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_preview(composite_query={"queries":[{"spec":"<spec>","type":"<type>"}]}, end=0)

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

resp, _, err := client.O11yAPI.PostO11yQueryRangePreview(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_preview(&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).postO11yQueryRangePreview();

curl -X POST https://api.hanzo.ai/v1/o11y/query_range/preview \
  -H "Authorization: Bearer $HANZO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
       "compositeQuery": {
         "queries": [
           {
             "spec": "<spec>",
             "type": "<type>"
           }
         ]
       },
       "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 format NextCreate query range