Campaign and funnel group endpoints.
Retrieve a campaign by its id
Retrieve a campaign by its id
query Parameters
apiKeyAn authorized api key
idCampaignRetrieve a campaign by its id › Responses
The requested campaign
idCampaign64 bits integer id of the campaign
campaignNameCampaign's name. 255 characters max.
Query parameters to add to the tracking url for all the funnels of this campaign, unless a specific funnel overwrites them
Custom tokens usable in conditions, JS nodes and PHP nodes for all the funnels of this campaign
isArchivedRetrieve a campaign by its name
Retrieve a campaign by its name
query Parameters
apiKeyAn authorized api key
nameRetrieve a campaign by its name › Responses
The requested campaign
idCampaign64 bits integer id of the campaign
campaignNameCampaign's name. 255 characters max.
Query parameters to add to the tracking url for all the funnels of this campaign, unless a specific funnel overwrites them
Custom tokens usable in conditions, JS nodes and PHP nodes for all the funnels of this campaign
isArchivedRetrieve all campaigns with the specified status
Retrieve all campaigns with the specified status
query Parameters
apiKeyAn authorized api key
statusRetrieve all campaigns with the specified status › Responses
List of campaigns with the specified status
idCampaign64 bits integer id of the campaign
campaignNameCampaign's name. 255 characters max.
Query parameters to add to the tracking url for all the funnels of this campaign, unless a specific funnel overwrites them
Custom tokens usable in conditions, JS nodes and PHP nodes for all the funnels of this campaign
isArchivedUpdate an existing campaign
Update an existing campaign. The id cannot be changed.
query Parameters
apiKeyAn authorized api key
Update an existing campaign › Request Body
idCampaign64 bits integer id of the campaign
campaignNameCampaign's name. 255 characters max.
Query parameters to add to the tracking url for all the funnels of this campaign, unless a specific funnel overwrites them
Custom tokens usable in conditions, JS nodes and PHP nodes for all the funnels of this campaign
isArchivedUpdate an existing campaign › Responses
Campaign updated successfully
Create a new campaign
Create a new campaign
query Parameters
apiKeyAn authorized api key
Create a new campaign › Request Body
idCampaign64 bits integer id of the campaign
campaignNameCampaign's name. 255 characters max.
Query parameters to add to the tracking url for all the funnels of this campaign, unless a specific funnel overwrites them
Custom tokens usable in conditions, JS nodes and PHP nodes for all the funnels of this campaign
isArchivedCreate a new campaign › Responses
Campaign created successfully
Get a lightweight list of campaigns
Get a lightweight list of campaigns
query Parameters
apiKeyAn authorized api key
archivedLegacy archive filter. If true, return archived campaigns only; if false, return active campaigns only.
statusFilter campaigns by status. Takes precedence over archived.
Get a lightweight list of campaigns › Responses
List of campaigns
idnameisArchivedstatuscategoryIdcategoryNamepageTypeidCampaigncampaignNamedefaultCostPerEntrancecostTypeClone an existing campaign
Clone an existing campaign
query Parameters
apiKeyAn authorized api key
idCampaignThe id of the campaign to clone
Clone an existing campaign › Responses
The cloned campaign
idnameisArchivedstatuscategoryIdcategoryNamepageTypeidCampaigncampaignNamedefaultCostPerEntrancecostType