Funnels and funnel configuration.
Retrieve a funnel by its id
Retrieve a funnel by its id
query Parameters
apiKeyAn authorized api key
idFunnelloadDependenciesIf true, load all funnel dependencies like nodes and connections
Retrieve a funnel by its id › Responses
The requested funnel
idFunnel64 bits integer unique id of the funnel
idCampaign64 bits integer id of the parent campaign
funnelNameFunnel's name. 255 characters max.
canvasWidthWidth in pixels of the funnel canvas. When creating nodes, their positions are given between 0.0 and 1.0. 0 being total left and 1 total right.
canvasHeightHeight in pixels of the funnel canvas. When creating nodes, their positions are given between 0.0 and 1.0. 0 being top and 1 for bottom.
defaultCostPerEntranceDefault cost to use in tracking urls when the used traffic source doesn't have any default cost. It can be a numeric value or a string (a cost token). 255 chars max.
Query parameters to add to the tracking url for this funnel
Custom tokens usable in conditions, JS nodes and PHP nodes
A list of traffic source cost overrides of incoming traffic for this funnel. The key represents the traffic source id and the value the new cost to apply to new visits from that traffic source.
A list of traffic source postback overrides for this funnel.
A list of nodes used in this funnel. Note this can be an empty array when a funnel is loaded without its dependencies.
A list of connections linking this funnel's nodes. Note this can be an empty array when a funnel is loaded without its dependencies.
isArchivedRetrieve a funnel by its name
Retrieve a funnel by its name
query Parameters
apiKeyAn authorized api key
idCampaignnameloadDependenciesIf true, load all funnel dependencies like nodes and connections
Retrieve a funnel by its name › Responses
The requested funnel
idFunnel64 bits integer unique id of the funnel
idCampaign64 bits integer id of the parent campaign
funnelNameFunnel's name. 255 characters max.
canvasWidthWidth in pixels of the funnel canvas. When creating nodes, their positions are given between 0.0 and 1.0. 0 being total left and 1 total right.
canvasHeightHeight in pixels of the funnel canvas. When creating nodes, their positions are given between 0.0 and 1.0. 0 being top and 1 for bottom.
defaultCostPerEntranceDefault cost to use in tracking urls when the used traffic source doesn't have any default cost. It can be a numeric value or a string (a cost token). 255 chars max.
Query parameters to add to the tracking url for this funnel
Custom tokens usable in conditions, JS nodes and PHP nodes
A list of traffic source cost overrides of incoming traffic for this funnel. The key represents the traffic source id and the value the new cost to apply to new visits from that traffic source.
A list of traffic source postback overrides for this funnel.
A list of nodes used in this funnel. Note this can be an empty array when a funnel is loaded without its dependencies.
A list of connections linking this funnel's nodes. Note this can be an empty array when a funnel is loaded without its dependencies.
isArchivedRetrieve all funnels with the specified status
Retrieve all funnels with the specified status
query Parameters
apiKeyAn authorized api key
statusloadDependenciesIf true, load all funnel dependencies like nodes and connections
Retrieve all funnels with the specified status › Responses
List of funnels with the specified status
idFunnel64 bits integer unique id of the funnel
idCampaign64 bits integer id of the parent campaign
funnelNameFunnel's name. 255 characters max.
canvasWidthWidth in pixels of the funnel canvas. When creating nodes, their positions are given between 0.0 and 1.0. 0 being total left and 1 total right.
canvasHeightHeight in pixels of the funnel canvas. When creating nodes, their positions are given between 0.0 and 1.0. 0 being top and 1 for bottom.
defaultCostPerEntranceDefault cost to use in tracking urls when the used traffic source doesn't have any default cost. It can be a numeric value or a string (a cost token). 255 chars max.
Query parameters to add to the tracking url for this funnel
Custom tokens usable in conditions, JS nodes and PHP nodes
A list of traffic source cost overrides of incoming traffic for this funnel. The key represents the traffic source id and the value the new cost to apply to new visits from that traffic source.
A list of traffic source postback overrides for this funnel.
A list of nodes used in this funnel. Note this can be an empty array when a funnel is loaded without its dependencies.
A list of connections linking this funnel's nodes. Note this can be an empty array when a funnel is loaded without its dependencies.
isArchivedUpdate an existing funnel
Update an existing funnel. The id cannot be changed.
query Parameters
apiKeyAn authorized api key
deleteDependenciesIf true, then delete all nodes and connections assigned to this funnel, in the database, before saving the new nodes and connections stored in the passed Funnel object. This will also delete the related node stats.
Update an existing funnel › Request Body
idFunnel64 bits integer unique id of the funnel
idCampaign64 bits integer id of the parent campaign
funnelNameFunnel's name. 255 characters max.
canvasWidthWidth in pixels of the funnel canvas. When creating nodes, their positions are given between 0.0 and 1.0. 0 being total left and 1 total right.
canvasHeightHeight in pixels of the funnel canvas. When creating nodes, their positions are given between 0.0 and 1.0. 0 being top and 1 for bottom.
defaultCostPerEntranceDefault cost to use in tracking urls when the used traffic source doesn't have any default cost. It can be a numeric value or a string (a cost token). 255 chars max.
Query parameters to add to the tracking url for this funnel
Custom tokens usable in conditions, JS nodes and PHP nodes
A list of traffic source cost overrides of incoming traffic for this funnel. The key represents the traffic source id and the value the new cost to apply to new visits from that traffic source.
A list of traffic source postback overrides for this funnel.
A list of nodes used in this funnel. Note this can be an empty array when a funnel is loaded without its dependencies.
A list of connections linking this funnel's nodes. Note this can be an empty array when a funnel is loaded without its dependencies.
isArchivedUpdate an existing funnel › Responses
Funnel updated successfully
Create a new funnel
Create a new funnel
query Parameters
apiKeyAn authorized api key
Create a new funnel › Request Body
idFunnel64 bits integer unique id of the funnel
idCampaign64 bits integer id of the parent campaign
funnelNameFunnel's name. 255 characters max.
canvasWidthWidth in pixels of the funnel canvas. When creating nodes, their positions are given between 0.0 and 1.0. 0 being total left and 1 total right.
canvasHeightHeight in pixels of the funnel canvas. When creating nodes, their positions are given between 0.0 and 1.0. 0 being top and 1 for bottom.
defaultCostPerEntranceDefault cost to use in tracking urls when the used traffic source doesn't have any default cost. It can be a numeric value or a string (a cost token). 255 chars max.
Query parameters to add to the tracking url for this funnel
Custom tokens usable in conditions, JS nodes and PHP nodes
A list of traffic source cost overrides of incoming traffic for this funnel. The key represents the traffic source id and the value the new cost to apply to new visits from that traffic source.
A list of traffic source postback overrides for this funnel.
A list of nodes used in this funnel. Note this can be an empty array when a funnel is loaded without its dependencies.
A list of connections linking this funnel's nodes. Note this can be an empty array when a funnel is loaded without its dependencies.
isArchivedCreate a new funnel › Responses
Funnel created successfully
Get a list of all funnels as id/name pairs
Get a list of all funnels as id/name pairs
query Parameters
apiKeyAn authorized api key
archivedIf true, include archived funnels
prefixWithCampaignNamesIf true, prefix funnel names with their campaign name
idCampaignFilter funnels by campaign id
Get a list of all funnels as id/name pairs › Responses
List of funnels
idnameClone an existing funnel
Move a funnel to a different campaign
Move a funnel to a different campaign
query Parameters
apiKeyAn authorized api key
Move a funnel to a different campaign › Request Body
idFunnelidCampaignMove a funnel to a different campaign › Responses
The moved funnel
idname