Hanzo
OpenapiO11y

Returns a trace's waterfall: every span when the trace is small enough, a…

Returns a trace's waterfall: every span when the trace is small enough, a capped window around the selected span when it is not, with the uncollapsed…

POST /v1/o11y/traces/{traceId}/waterfall

Addresshttps://api.hanzo.ai/v1/o11y/traces/{traceId}/waterfall
MethodPOST
OperationGetWaterfallV4
AuthAuthorization: Bearer $HANZO_API_KEY

Returns a trace's waterfall: every span when the trace is small enough, a capped window around the selected span when it is not, with the uncollapsed subtrees the caller asked to keep open.

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

Request

3 fields, body application/json (required).

FieldInTypeRequiredDescription
traceIdpathstringyes
selectedSpanIdbodystring
uncollapsedSpansbodystring[]

Response

StatusBodyMeaning
200o11y.O11yTraceWaterfallOutok

200 body — 51 fields.

FieldInTypeAlwaysDescription
databodyo11y.GettableWaterfallTrace
data.endTimestampMillisbodyinteger
data.hasMissingSpansbodyboolean
data.hasMorebodyboolean
data.rootServiceEntryPointbodystring
data.rootServiceNamebodystring
data.spansbodyo11y.WaterfallSpan[]
data.spans[].attributesbodyobject
data.spans[].attributes.*bodyobject
data.spans[].db_namebodystringCalculated fields https://o11y.io/docs/traces-management/guides/derived-fields-spans
data.spans[].db_operationbodystring
data.spans[].duration_nanobodyinteger
data.spans[].eventsbodyo11y.Event[]
data.spans[].events[].attributeMapbodyobject
data.spans[].events[].attributeMap.*bodyobject
data.spans[].events[].isErrorbodyboolean
data.spans[].events[].namebodystring
data.spans[].events[].timeUnixNanobodyinteger
data.spans[].external_http_methodbodystring
data.spans[].external_http_urlbodystring
data.spans[].flagsbodyinteger
data.spans[].has_childrenbodyboolean
data.spans[].has_errorbodyboolean
data.spans[].http_hostbodystring
data.spans[].http_methodbodystring
data.spans[].http_urlbodystring
data.spans[].is_remotebodystring
data.spans[].kind_stringbodystring
data.spans[].levelbodyinteger
data.spans[].namebodystring
data.spans[].parent_span_idbodystring
data.spans[].referencesbodyo11y.OtelSpanRef[]
data.spans[].references[].refTypebodystring
data.spans[].references[].spanIdbodystring
data.spans[].references[].traceIdbodystring
data.spans[].resourcebodyobject
data.spans[].resource.*bodystring
data.spans[].response_status_codebodystring
data.spans[].span_idbodystring
data.spans[].status_codebodyinteger
data.spans[].status_code_stringbodystring
data.spans[].status_messagebodystring
data.spans[].sub_tree_node_countbodyinteger
data.spans[].time_unixbodyinteger
data.spans[].trace_idbodystring
data.spans[].trace_statebodystring
data.startTimestampMillisbodyinteger
data.totalErrorSpansCountbodyinteger
data.totalSpansCountbodyinteger
data.uncollapsedSpansbodystring[]
statusbodystringStatus is "success".

Failure carries the platform error shape — see Errors.

Examples

hanzo o11y traces waterfall <traceId>

O11y API · All Hanzo APIs · Interactive reference

How is this guide?

On this page