Workflow funnel overlay

Search Documentation

Search across all developer documentation

workflows

Workflow funnel overlay

GET /v1/workflows/{id}/funnel
Auth required api.workflows.view

Per-node funnel aggregates (runs and entries per node) plus per-send-node outcome counts, for one definition version. Defaults to the current version; pin an older one with ?version=.

Path parameters

id string<uuid> required

Resource UUID. An unparseable id reads as a clean 404 not_found.

Query parameters

version integer optional

Definition version to aggregate (default the current version).

Responses

200 The funnel overlay application/json
401 Missing, malformed, or unknown API key application/problem+json
403 Key lacks the required scope or plan limit violated application/problem+json
404 Resource not found application/problem+json
422 Query parameter or path value failed validation application/problem+json
429 Per-org rate limit exceeded application/problem+json
500 Unexpected server-side failure. The code is internal_error. The request_id field can be quoted to SendOps support to investigate. application/problem+json