List funnels
List all funnels
query Parameters
statusStatus of resource
funnelTypeOptional funnel type filter
List funnels › Responses
List of funnels
idFunnelID of the funnel
funnelNameFunnel's name.
statusidFunnelGroupID of the parent funnel group
funnelGroupNameName of the parent funnel group
Find funnel by ID
Retrieve a funnel by its id
query Parameters
idFunnelThe ID of the funnel to retrieve
Find funnel by ID › Responses
The requested funnel
idFunnelID of the funnel
idCampaignID of the parent campaign (legacy alias for idFunnelGroup)
funnelNameFunnel's name.
idFunnelGroupID of the parent funnel group
funnelTypecanvasWidthcanvasHeightQuery parameters to add to the tracking url for this funnel
A list of traffic source cost overrides. The key represents the traffic source id and the value the new cost to apply to new visits from that traffic source. Optional: omit or send an empty object to apply default costs.
A list of traffic source postback overrides for this funnel.
ipAnonymizerOptional. Per-funnel IP anonymization. Set this only if you want this funnel to differ from your account default. If omitted, the account-level user-settings value is applied (which may anonymize visitor IPs); omitting is NOT equivalent to "disabled".
A list of nodes used in this funnel
A list of connections linking this funnel's nodes.
defaultCoststatusownerOnly filled by loading endpoints. Ignored for all saving operations as the owner is already passed as the endpoint's key query param.
Reserved for the FunnelFlux user interface (UI state and edit version/conflict tracking). For internal UI use only; do not store your own data here via the API, as the UI may overwrite it.
Find funnels by ID list
Retrieve all funnels with the specified ids
query Parameters
idFunnelsList of the funnel IDs to filter to
Find funnels by ID list › Responses
List of funnels with the specified status
idFunnelID of the funnel
idCampaignID of the parent campaign (legacy alias for idFunnelGroup)
funnelNameFunnel's name.
idFunnelGroupID of the parent funnel group
funnelTypecanvasWidthcanvasHeightQuery parameters to add to the tracking url for this funnel
A list of traffic source cost overrides. The key represents the traffic source id and the value the new cost to apply to new visits from that traffic source. Optional: omit or send an empty object to apply default costs.
A list of traffic source postback overrides for this funnel.
ipAnonymizerOptional. Per-funnel IP anonymization. Set this only if you want this funnel to differ from your account default. If omitted, the account-level user-settings value is applied (which may anonymize visitor IPs); omitting is NOT equivalent to "disabled".
A list of nodes used in this funnel
A list of connections linking this funnel's nodes.
defaultCoststatusownerOnly filled by loading endpoints. Ignored for all saving operations as the owner is already passed as the endpoint's key query param.
Reserved for the FunnelFlux user interface (UI state and edit version/conflict tracking). For internal UI use only; do not store your own data here via the API, as the UI may overwrite it.
Find funnels by status
Retrieve all funnels with the specified status
query Parameters
statusStatus of resource
idCampaignThe funnel group to filter to
Find funnels by status › Responses
List of funnels with the specified status
idFunnelID of the funnel
funnelNameFunnel's name.
statusidFunnelGroupID of the parent funnel group
funnelGroupNameName of the parent funnel group
Find funnels by type
Retrieve all funnels with the specified type
query Parameters
funnelTypeType of funnel
Find funnels by type › Responses
List of funnels with the specified type
idFunnelID of the funnel
idCampaignID of the parent campaign (legacy alias for idFunnelGroup)
funnelNameFunnel's name.
idFunnelGroupID of the parent funnel group
funnelTypecanvasWidthcanvasHeightQuery parameters to add to the tracking url for this funnel
A list of traffic source cost overrides. The key represents the traffic source id and the value the new cost to apply to new visits from that traffic source. Optional: omit or send an empty object to apply default costs.
A list of traffic source postback overrides for this funnel.
ipAnonymizerOptional. Per-funnel IP anonymization. Set this only if you want this funnel to differ from your account default. If omitted, the account-level user-settings value is applied (which may anonymize visitor IPs); omitting is NOT equivalent to "disabled".
A list of nodes used in this funnel
A list of connections linking this funnel's nodes.
defaultCoststatusownerOnly filled by loading endpoints. Ignored for all saving operations as the owner is already passed as the endpoint's key query param.
Reserved for the FunnelFlux user interface (UI state and edit version/conflict tracking). For internal UI use only; do not store your own data here via the API, as the UI may overwrite it.
Find funnels by category
Retrieve all funnels under the specified category
query Parameters
idCategoryParent category of resource
Find funnels by category › Responses
List of funnels in the category
idFunnelID of the funnel
idCampaignID of the parent campaign (legacy alias for idFunnelGroup)
funnelNameFunnel's name.
idFunnelGroupID of the parent funnel group
funnelTypecanvasWidthcanvasHeightQuery parameters to add to the tracking url for this funnel
A list of traffic source cost overrides. The key represents the traffic source id and the value the new cost to apply to new visits from that traffic source. Optional: omit or send an empty object to apply default costs.
A list of traffic source postback overrides for this funnel.
ipAnonymizerOptional. Per-funnel IP anonymization. Set this only if you want this funnel to differ from your account default. If omitted, the account-level user-settings value is applied (which may anonymize visitor IPs); omitting is NOT equivalent to "disabled".
A list of nodes used in this funnel
A list of connections linking this funnel's nodes.
defaultCoststatusownerOnly filled by loading endpoints. Ignored for all saving operations as the owner is already passed as the endpoint's key query param.
Reserved for the FunnelFlux user interface (UI state and edit version/conflict tracking). For internal UI use only; do not store your own data here via the API, as the UI may overwrite it.
Update a funnel
Update an existing funnel. The id cannot be changed.
Update a funnel › Request Body
idFunnelID of the funnel
idCampaignID of the parent campaign (legacy alias for idFunnelGroup)
funnelNameFunnel's name.
idFunnelGroupID of the parent funnel group
funnelTypecanvasWidthcanvasHeightQuery parameters to add to the tracking url for this funnel
A list of traffic source cost overrides. The key represents the traffic source id and the value the new cost to apply to new visits from that traffic source. Optional: omit or send an empty object to apply default costs.
A list of traffic source postback overrides for this funnel.
ipAnonymizerOptional. Per-funnel IP anonymization. Set this only if you want this funnel to differ from your account default. If omitted, the account-level user-settings value is applied (which may anonymize visitor IPs); omitting is NOT equivalent to "disabled".
A list of nodes used in this funnel
A list of connections linking this funnel's nodes.
defaultCoststatusownerOnly filled by loading endpoints. Ignored for all saving operations as the owner is already passed as the endpoint's key query param.
Reserved for the FunnelFlux user interface (UI state and edit version/conflict tracking). For internal UI use only; do not store your own data here via the API, as the UI may overwrite it.
Update a funnel › Responses
Funnel updated successfully
Create a funnel
Create a new funnel
Create a funnel › Request Body
idFunnelID of the funnel
idCampaignID of the parent campaign (legacy alias for idFunnelGroup)
funnelNameFunnel's name.
idFunnelGroupID of the parent funnel group
funnelTypecanvasWidthcanvasHeightQuery parameters to add to the tracking url for this funnel
A list of traffic source cost overrides. The key represents the traffic source id and the value the new cost to apply to new visits from that traffic source. Optional: omit or send an empty object to apply default costs.
A list of traffic source postback overrides for this funnel.
ipAnonymizerOptional. Per-funnel IP anonymization. Set this only if you want this funnel to differ from your account default. If omitted, the account-level user-settings value is applied (which may anonymize visitor IPs); omitting is NOT equivalent to "disabled".
A list of nodes used in this funnel
A list of connections linking this funnel's nodes.
defaultCoststatusownerOnly filled by loading endpoints. Ignored for all saving operations as the owner is already passed as the endpoint's key query param.
Reserved for the FunnelFlux user interface (UI state and edit version/conflict tracking). For internal UI use only; do not store your own data here via the API, as the UI may overwrite it.
Create a funnel › Responses
Funnel created successfully
Duplicate a funnel
Create duplicate of existing funnel.
query Parameters
idFunnelID of the funnel to duplicate.
Duplicate a funnel › Request Body
nameName for the new funnel
parentIdRequired funnel group ID for the new funnel.
Optional field overrides to merge into the duplicated funnel. Keys are JSON field names. Protected fields (ID, owner, status, idFunnelGroup) cannot be changed via this field — they are always set by the server after the merge.
Duplicate a funnel › Responses
The newly created funnel
idID of the newly created asset
Delete a funnel
Delete the specified funnels along with their nodes and connections. Deletion is a soft-delete (status is set to "deleted"; records are retained so historical reporting can still resolve IDs to names, and existing tracking links keep working). Cascade: the funnel's funnel-scoped (local) assets are soft-deleted alongside it: page groups and conditions whose restrictToFunnelId points at this funnel, plus AI node settings belonging to this funnel (AI node settings are always funnel-specific, since they configure a rotator that only exists within one funnel). Logic scripts are global assets and are not deleted by funnel cascade. Global assets are never affected, and pages are never deleted (a page is a global asset that may be used by many funnels); delete pages explicitly if you no longer need them.
Delete a funnel › Responses
Funnels deleted successfully