Funnel
Private Funnel API endpoints
Query parameters
expand[]optionalstring[]List of relations to expand in the response. Each expandable field on the response schema names its key, e.g. expand[]=customer. Nested keys use dot notation, e.g. items.product or subscriptions.items. Fields marked as always present are returned without being requested. An expanded list is null, not [], when there are no records. Unknown keys are ignored unless the endpoint says otherwise.
queryoptionalstringSearch query
ReturnsFunnel[]
Funnels list response
Error responses
422objectexpand is not an array or holds a value other than steps, or query is not a string or is longer than 255 characters.
Path parameters
funnel_idRequiredintegerFunnel ID
Query parameters
expand[]optionalstring[]List of relations to expand in the response. Each expandable field on the response schema names its key, e.g. expand[]=customer. Nested keys use dot notation, e.g. items.product or subscriptions.items. Fields marked as always present are returned without being requested. An expanded list is null, not [], when there are no records. Unknown keys are ignored unless the endpoint says otherwise.
ReturnsFunnel
Funnel object response
Error responses
400objectThe funnel belongs to another shop.
404objectNo funnel with this ID exists.
422objectexpand is not an array or holds a value other than steps.