Hanzo
OpenapiO11y

Validates a composite query and renders the Datastore statements it would run…

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

Addresshttps://api.hanzo.ai/v1/o11y/query_range/preview
MethodPOST
Operationpost_o11y_query_range_preview
AuthAuthorization: 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).

FieldInTypeRequiredDescription
compositeQuerybodyo11y.querybuildertypesv5.CompositeQuery
compositeQuery.queriesbodyo11y.QueryEnvelope[]Queries is the queries to use for the request.
compositeQuery.queries[].specbodyobjectSpec is the deferred decoding of the query if any.
compositeQuery.queries[].typebodyanyType is the type of the query.
endbodyinteger
formatOptionsbodyo11y.FormatOptions
formatOptions.fillGapsbodyboolean
formatOptions.formatTableResultForUIbodyboolean
noCachebodyboolean
requestTypebodyany
schemaVersionbodystring
startbodyinteger
variablesbodyobject
variables.*bodyo11y.VariableItem
variables.*.typebodyany
variables.*.valuebodyobject
verbosebodystringVerbose selects the answer's depth. Empty or "true" renders the underlying Datastore SQL with EXPLAIN and granule analysis; "false" returns only the per-query…

Response

StatusBodyMeaning
200o11y.O11yQueryRangePreviewOutok

200 body — 2 fields.

FieldInTypeAlwaysDescription
databodyanyData holds one preview per query, keyed by query name — the rendered statements with optional EXPLAIN and granule analysis, or the per-query verdict.
statusbodystringStatus is "success".

Failure carries the platform error shape — see Errors.

Examples

hanzo o11y query_range preview

O11y API · All Hanzo APIs · Interactive reference

How is this guide?

On this page