Hanzo
OpenapiO11y

Substitutes a query's variables and returns the resolved request, without…

Substitutes a query's variables and returns the resolved request, without running it — what a dashboard does before it queries.

POST /v1/o11y/substitute_vars

Addresshttps://api.hanzo.ai/v1/o11y/substitute_vars
MethodPOST
Operationpost_o11y_substitute_vars
AuthAuthorization: Bearer $HANZO_API_KEY

Substitutes a query's variables and returns the resolved request, without running it — what a dashboard does before it queries.

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

Request

16 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.
endbodyintegerEnd is the end time of the query in epoch milliseconds.
formatOptionsbodyo11y.FormatOptions
formatOptions.fillGapsbodyboolean
formatOptions.formatTableResultForUIbodyboolean
noCachebodybooleanNoCache is a flag to disable caching for the request.
requestTypebodyanyRequestType is the type of the request.
schemaVersionbodystringSchemaVersion is the version of the schema to use for the request payload.
startbodyintegerStart is the start time of the query in epoch milliseconds.
variablesbodyobjectVariables is the variables to use for the request.
variables.*bodyo11y.VariableItem
variables.*.typebodyany
variables.*.valuebodyobject

Response

StatusBodyMeaning
200o11y.O11ySubstituteVarsOutok

200 body — 2 fields.

FieldInTypeAlwaysDescription
databodyanyData is the resolved composite query, with its variables substituted.
statusbodystringStatus is "success".

Failure carries the platform error shape — see Errors.

Examples

hanzo o11y substitute_vars

O11y API · All Hanzo APIs · Interactive reference

How is this guide?

On this page