Hanzo
OpenapiO11y

Watch one running query's progress

Reports how far a submitted query has got — rows scanned, bytes read, elapsed — and HOLDS the connection until the next update rather than answering…

GET /v1/o11y/query_progress

Addresshttps://api.hanzo.ai/v1/o11y/query_progress
MethodGET
Operationget_o11y_query_progress
AuthAuthorization: Bearer $HANZO_API_KEY

Reports how far a submitted query has got — rows scanned, bytes read, elapsed — and HOLDS the connection until the next update rather than answering immediately.

ONE ADDRESS, TWO PROTOCOLS. Send an Upgrade and this is a websocket carrying the same progress; send an ordinary GET and it is a long poll. The Upgrade is a property of the request, not of the address, so the read that used to answer at /ws/query_progress answers here.

The long poll is the whole point, and the reason this cannot be a typed operation: an answer that arrived only when the query finished would report progress on nothing, and an upgraded connection has no JSON response to declare.

A validated, org-scoped principal is required; a query id belonging to another tenant is simply not found.

Request

GET /v1/o11y/query_progress takes no parameters and no body — the credential is the whole request.

Response

The document declares no response body for this operation. It answers 200 on success and the platform error shape on failure — see Errors.

Examples

hanzo o11y query_progress

O11y API · All Hanzo APIs · Interactive reference

How is this guide?

On this page