Hanzo
OpenapiO11y

Renames a funnel or rewrites its description, answering the funnel as it now…

Renames a funnel or rewrites its description, answering the funnel as it now stands.

PUT /v1/o11y/trace-funnels/{funnel_id}

Addresshttps://api.hanzo.ai/v1/o11y/trace-funnels/{funnel_id}
MethodPUT
OperationUpdateTraceFunnel
AuthAuthorization: Bearer $HANZO_API_KEY

Renames a funnel or rewrites its description, answering the funnel as it now stands.

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

Request

4 fields, body application/json (required).

FieldInTypeRequiredDescription
funnel_idpathstringyes
descriptionbodystringDescription replaces the funnel's description.
funnel_namebodystringName replaces the funnel's name.
timestampbodyintegerTimestamp is when the change was made, as a millisecond epoch.

Response

StatusBodyMeaning
200o11y.O11yFunnelOutok

200 body — 72 fields.

FieldInTypeAlwaysDescription
databodyo11y.GettableFunnel
data.created_atbodyinteger
data.created_bybodystring
data.descriptionbodystring
data.funnelbodyo11y.StorableFunnel
data.funnel.createdAtbodystring (date-time)
data.funnel.createdBybodystring
data.funnel.descriptionbodystring
data.funnel.funnel_namebodystring
data.funnel.idbodyany
data.funnel.org_idbodyany
data.funnel.stepsbodyo11y.FunnelStep[]
data.funnel.steps[].descriptionbodystringstep description
data.funnel.steps[].filtersbodyo11y.FilterSet
data.funnel.steps[].filters.itemsbodyo11y.FilterItem[]
data.funnel.steps[].filters.items[].keybodyo11y.AttributeKey
data.funnel.steps[].filters.items[].key.dataTypebodystring
data.funnel.steps[].filters.items[].key.isColumnbodyboolean
data.funnel.steps[].filters.items[].key.isJSONbodyboolean
data.funnel.steps[].filters.items[].key.keybodystring
data.funnel.steps[].filters.items[].key.typebodystring
data.funnel.steps[].filters.items[].opbodystring
data.funnel.steps[].filters.items[].valuebodyobject
data.funnel.steps[].filters.opbodystring
data.funnel.steps[].has_errorsbodyboolean
data.funnel.steps[].idbodyany
data.funnel.steps[].latency_pointerbodystring
data.funnel.steps[].latency_typebodystring
data.funnel.steps[].namebodystringstep name
data.funnel.steps[].service_namebodystring
data.funnel.steps[].span_namebodystring
data.funnel.steps[].step_orderbodyinteger
data.funnel.tagsbodystring
data.funnel.updatedAtbodystring (date-time)
data.funnel.updatedBybodystring
data.funnel.userbodyo11y.User
data.funnel.user.createdAtbodystring (date-time)
data.funnel.user.displayNamebodystring
data.funnel.user.emailbodyany
data.funnel.user.idbodyany
data.funnel.user.isRootbodyboolean
data.funnel.user.orgIdbodyany
data.funnel.user.statusbodyany
data.funnel.user.updatedAtbodystring (date-time)
data.funnel_idbodystring
data.funnel_namebodystring
data.org_idbodystring
data.stepsbodyo11y.FunnelStep[]
data.steps[].descriptionbodystringstep description
data.steps[].filtersbodyo11y.FilterSet
data.steps[].filters.itemsbodyo11y.FilterItem[]
data.steps[].filters.items[].keybodyo11y.AttributeKey
data.steps[].filters.items[].key.dataTypebodystring
data.steps[].filters.items[].key.isColumnbodyboolean
data.steps[].filters.items[].key.isJSONbodyboolean
data.steps[].filters.items[].key.keybodystring
data.steps[].filters.items[].key.typebodystring
data.steps[].filters.items[].opbodystring
data.steps[].filters.items[].valuebodyobject
data.steps[].filters.opbodystring
data.steps[].has_errorsbodyboolean
data.steps[].idbodyany
data.steps[].latency_pointerbodystring
data.steps[].latency_typebodystring
data.steps[].namebodystringstep name
data.steps[].service_namebodystring
data.steps[].span_namebodystring
data.steps[].step_orderbodyinteger
data.updated_atbodyinteger
data.updated_bybodystring
data.user_emailbodystring
statusbodystringStatus is "success".

Failure carries the platform error shape — see Errors.

Examples

hanzo o11y trace-funnels set <funnel_id>

O11y API · All Hanzo APIs · Interactive reference

How is this guide?

On this page