DuplicateRequest
nameName for the new asset
parentIdOptional parent/category ID for the new asset
Optional field overrides to merge into the duplicated asset. Keys are JSON field names (e.g. baseURL, trackingFieldSlots). Protected fields (ID, owner, status) cannot be changed via this field — they are always set by the server after the merge.
FunnelDuplicateRequest
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.
OfferSourceCategoryInfo
idCategoryID of the category
categoryNameCategory's name.
statusOfferSourceInfo
idOfferSourceID of the offer source
offerSourceNameOffer source's name.
statusidCategoryID of the parent category
categoryNameName of the parent category
OfferSource
idOfferSourceID of the offer source
offerSourceNameOffer source's name.
Query parameters to add to the url. Tokens can be used as values.
postbackSubIdName of the subid parameter your offer source sends back to FunnelFlux when a conversion occurs
postbackTxIdName of the unique transaction id parameter your offer source sends back to FunnelFlux when a conversion occurs
postbackPayoutName of the payout parameter your offer source sends back to FunnelFlux when a conversion occurs
statusidCategoryCategory ID. Empty if uncategorized
Free form object to store any custom data
TrackingField
namevaluepreviousNamestatusTrafficSourceCategoryInfo
idCategoryID of the category
categoryNameCategory's name.
statusTrafficSourceInfo
idTrafficSourceID of the traffic source
trafficSourceNameTraffic source's name.
statusidCategoryID of the parent category
categoryNameName of the parent category
TrafficSource
idTrafficSourceID of the traffic source
trafficSourceNameTraffic source's name.
costTypedefaultCostDEPRECATED
Allowed keys are campaign, external and c1 to c20 - see example
statusidCategoryCategory ID. Empty if uncategorized
Free form object for storing custom scenario data (deprecated)
Free form object for storing conversion tracking settings (UI usage only)
Free form object to store any custom data
incomingCostModifierIncoming cost modifier in percent. This value is used to adjust the incoming cost of a traffic source. For example, if the incoming cost is $1 and the incoming cost modifier is 50, the incoming cost will be adjusted to $0.5. This number should be between 0 and 500.
outgoingRevenueModifierOutgoing revenue modifier in percent. This value is used to adjust the outgoing revenue of a traffic source. For example, if the outgoing revenue is $1 and the outgoing revenue modifier is 50, the outgoing revenue sent in postbacks will be $0.5. This number should be between 0 and 500.
outgoingPostbackProbabilityOutgoing postback probability in percent. This value is used to determine the probability of sending a postback to the traffic source. For example, if the outgoing postback probability is 50, then there is a 50% chance that a postback will be sent to the traffic source. This number should be between 0 and 100.
disableZeroRevenuePostbacksIf true, then zero revenue postbacks will not be sent for this traffic source. This is useful for filtering events of zero revenue which may not be desirable to send to the traffic source.
MoveCategoryRequest
entriesList of asset IDs to move
idCategoryTarget category ID (empty string to remove from category)
Postback
idTrafficSourcepostbackTypepostbackCodeDEPRECATED
postbackURLpostbackHTMLFunnelNodeRotatorParams
rotatorTypeHow the rotator will operate.
stickinessModeControls rotation behavior for repeat visitors within their session.
- none: Always rotate randomly (default behavior)
- sticky: Always show same destination for returning visitors
- antiAffinity: Cycle through all destinations before repeating any
FunnelNodePageParams
idPageID of the lander or offer page
accumulateUrlParamsIf true, then the accumulated URL params are forwarded to this node's url
Tokens to compute and then forward to this node's url
redirectOverrideAllows to override a page's default redirectType
FunnelNodeExternalUrlParams
urlURL to redirect to
redirectTypeWhat http code should be used to redirect to the external URL.
FunnelNodeVisitorTagParams
addTagIdsTag IDs to add to the visitor
removeTagIdsTag IDs to remove from the visitor
FunnelNodeLabelParams
labelTextThe text to display on the label
labelColorA hex code for the label's background color
PageGroupInfo
idPageGrouppageGroupNamePage group's name.
statuspageTypeType of pages in this group (lander or offer)
idCategoryID of the category
categoryNameName of the parent category
PageGroup
idPageGrouppageGroupNamePage group's name.
pageTypeWhat kind of pages in this group.
routingList of page entries
restrictToFunnelIdIf empty, then page group is global and can be used by multiple funnels, otherwise, page group is local and can be used only by the funnel with id specified in this field.
stickinessModeControls rotation behavior for repeat visitors (only applies when routing is "rotator").
- none: Always rotate randomly (default behavior)
- sticky: Always show same page for returning visitors
- antiAffinity: Cycle through all pages before repeating any
statusFree form object to store any custom data
PageGroupEntry
idPageweightThe page's weight from 0.0 to 1.0
FunnelNode
idNodeID of the node
nodeNamenodeTypeThe type of this node. Depending on the value, different parameters may be required.
- If nodeType is 'root' or 'rotator' then the property 'nodeRotatorParams' is optional
- If nodeType is 'lander' or 'offer' then the property 'nodePageParams' is required
- If nodeType is 'externalUrl' then the property 'nodeExternalUrlParams' is required
- If nodeType is 'condition' then the property 'nodeConditionParams' is required
- If nodeType is 'landerGroup' or 'offerGroup' then the property 'nodePageGroupParams' is required
- If nodeType is 'visitorTag' then the property 'nodeVisitorTagParams' is required
- If nodeType is 'actionProxy' then no additional node parameters are required (routing is defined via connectionActionProxyParams on outgoing connections)
- If nodeType is 'label' then the property 'nodeLabelParams' is required
posXNode's X position in the funnel canvas.
posYNode's Y position in the funnel canvas.
isGlobalNodeWhether the node is global or not
statusFunnelConnectionRotatorParams
weightThe connection weight from 0.0 to 1.0
FunnelConnectionPageParams
onActionNumbersThe array of 'Action' numbers that will lead the visitor through this connection.
isConversionDetermines if this action leads to a conversion of the source page node
Inline conversion specs for this connection
isCustomEventDetermines if this action leads to a custom event of the source page node
Inline custom event specs for this connection
FunnelConnectionCodeParams
onDoneNumber'Done' number that will lead the visitor through this connection.
FunnelConnectionConditionParams
onRouteId^[a-z0-9_]{1,64}$Stable V2 condition route reference. For V2 conditions, this is the canonical connection key.
Must match one routes[].idRoute on the referenced condition.
Use default for the default route connection.
If any route on the referenced condition uses idRoute/priority, every connection from that condition node must use onRouteId.
onRouteNumberLegacy V1 route reference. Used only for legacy conditions without routes[].idRoute. For V2 conditions, use onRouteId; onRouteNumber is not canonical. For V2 it may be sent as a numeric priority snapshot for compatibility/debugging, but routing identity is onRouteId.
FunnelConnectionActionProxyParams
onActionNumbersThe array of 'Action' numbers that will lead the visitor through this connection.
FunnelConnection
idConnectionID of the funnel
idSourceNodeID of the connection's source node. Depending on the type of the source node, different parameters may be required.
- If source's nodeType is 'root' or 'rotator' then the property 'connectionRotatorParams' is required
- If source's nodeType is 'lander', 'offer', 'landerGroup' or 'offerGroup' then the property 'connectionPageParams' is required
- If source's nodeType is 'condition' then the property 'connectionConditionParams' is required
- If source's nodeType is 'actionProxy' then the property 'connectionActionProxyParams' is required
idTargetNodeID of the connection's target node
labelLocationConnection label's location on the link between the source and target nodes. From 0.0 to 1.0. 0.0 - positioned on the source node and 1.0 - positioned on the target node.
RuleVisitorTagParams
tagIdVisitor tag ID to test against the current visitor/session tag set
RuleTimeDateParams
yearmonthdayutcOffsetMinutesUTC offset in minutes for timezone-aware evaluation. If not set, uses visitor timezone.
RuleTimeOfDayParams
hourminutesutcOffsetMinutesUTC offset in minutes for timezone-aware evaluation. If not set, uses visitor timezone.
RuleTimeDayOfWeekParams
dayutcOffsetMinutesUTC offset in minutes for timezone-aware evaluation. If not set, uses visitor timezone.
RuleTimeDayOfMonthParams
dayutcOffsetMinutesUTC offset in minutes for timezone-aware evaluation. If not set, uses visitor timezone.
RuleTimeMonthOfYearParams
monthutcOffsetMinutesUTC offset in minutes for timezone-aware evaluation. If not set, uses visitor timezone.
FunnelConditionRule
attributeDepending on the selected attribute, some other properties may become required.
- For 'Time: Date', timeDateParams is required
- For 'Time: Time of Day', timeOfDayParams is required
- For 'Time: Day of Week', timeDayOfWeekParams is required
- For 'Time: Day of Month', timeDayOfMonthParams is required
- For 'Time: Month of Year', timeMonthOfYearParams is required
- For 'Tracking Field', trackingFieldParams is required
- For 'visitorTag', visitorTagParams is required. Use test 'is' for present and 'is not' for not present.
- For all other attributes, genericParams is required
testTest operator
The date is tested against the visitor's timezone.
The time is tested against the visitor's timezone
The day is tested against the visitor's timezone
The day is tested against the visitor's timezone
The month is tested against the visitor's timezone
FunnelConditionGroup
operatorFunnelConditionRoute
routeNameHuman-readable route name. In V2, Default Route is reserved for the default route only.
operatoridRoute^[a-z0-9_]{1,64}$Stable condition route identifier for V2 condition routing.
Required when the condition uses V2 route IDs. Must be unique within the condition.
Allowed characters: lowercase a-z, 0-9, underscore. Maximum 64 characters.
The reserved value default is required for the default route and cannot be used by any other route.
When upgrading an active condition to V2, update every referencing condition-node connection to use connectionConditionParams.onRouteId before routing traffic through the updated condition.
priorityV2 route evaluation order. Required when idRoute is present. Lower values are evaluated first. Priority 0 is reserved for the default route. Priorities must be unique within the condition. Changing priority changes evaluation order only; V2 funnel connection identity is routes[].idRoute plus connectionConditionParams.onRouteId. Do not update an active condition to V2 without also updating its funnel connections to onRouteId; V2 conditions with legacy numeric-only connections fail closed at Edge.
FunnelCondition
idConditionID of the condition
conditionNameidCategoryCategory ID. Empty if uncategorized
restrictToFunnelIdIf empty, then can be used in all funnels, otherwise, id of the funnel that can use this condition.
statusFree form object to store any custom data
FunnelConditionCategoryInfo
idCategoryID of the condition's category
categoryNameCategory's name.
statusFunnelConditionInfo
idConditionID of the condition
conditionNameCondition's name.
statusidCategoryID of the parent category
categoryNameName of the parent category
FunnelVisitorTag
idTagID of the tag
tagNameTag name
statuscolorDisplay color for the tag
idCategoryCategory ID for organizing tags
categoryNameCategory name for organizing tags
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.
A list of traffic source postback overrides for this funnel.
ipAnonymizerIP Anonymizer Type. If not set, use option from user settings
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.
Free form object to store any custom data
CampaignInfo
idCampaignID of the campaign
campaignNameCampaign's name.
statusFunnelInfo
idFunnelID of the funnel
funnelNameFunnel's name.
statusidFunnelGroupID of the parent funnel group
funnelGroupNameName of the parent funnel group
Campaign
idCampaignID of the campaign
campaignNameCampaign's name.
Query parameters to add to the tracking url for all the funnels of this campaign, unless a specific funnel overwrites them
defaultCoststatusFree form object to store any custom data
FunnelGroupInfo
idFunnelGroupID of the funnel group
funnelGroupNameFunnel group's name.
statusFunnelGroup
idFunnelGroupID of the funnel group
funnelGroupNameFunnel group's name.
Query parameters to add to the tracking url for all the funnels of this funnel group, unless a specific funnel overwrites them
defaultCoststatusFree form object to store any custom data
Category
idCategoryID of category. Use an empty string on assets to mean no category; empty string is not a persisted category row.
categoryNameCategory name
categoryTypeCategory type
statusFree form object to store any custom data
PageCategoryInfo
idCategoryID of the category
categoryNameCategory's name.
statusPageInfo
idPageID of the page
pageNamePage's name.
statusidCategoryID of the category
pageTypeType of page (lander or offer)
idOfferSourceID of the offer source for offer pages
categoryNameName of the parent category
offerSourceNameName of the offer source for offer pages
Page
idPageID of the page
pageTypeWhat kind of page. If 'offer' then 'offerParams' is required
pageNamePage's name.
baseURLRedirects to this URL when page is displayed
redirectTypeHow to redirect to the page's URL. 'umr' means 'Ultimate Meta Refresh'. By default, it uses the redirect type mentioned in the system settings for landers and offers.
Query parameters to add to the base url. Tokens can be used as values.
idCategoryCategory ID. Empty if uncategorized
notesOptional notes for this page
statusFree form object to store any custom data
disableAppendVidWhether the page can be append visitor id or not.
UserSettings
defaultHomepageURLURL of default homepage, keep empty for 404 response
defaultOfferRedirectDefault redirect type for offers. See more about types in Page.redirectType description
defaultLanderRedirectDefault redirect type for landers. See more about types in Page.redirectType description
ipAnonymizerIP Anonymizer name
defaultCustomDomainDefault custom domain name from 'customDomains' collection
Keys from third parties
savedViewsCustom event number to alias mappings for reporting
CustomEventAliasInfo
aliasAlias for the custom event
shortAliasShort alias for the custom event
IntegrationAPIKey
keyGenerated API key
apiAPI that can be used with given key
nameAPI key name
statusGenerateIntegrationAPIKeyRequest
apiAPI that can be used with given key
nameAPI key name
UpdateIntegrationAPIKeyRequest
keyAPI key to update
nameAPI key name
statusError
codemessagefieldAn optional field that may contains name of field that caused the error
AINodeSetting
funnelIdID of the funnel
segmentBySegment by
routingGoalRouting goal
lookbackWindowLookback window in hours
updateFrequencyUpdate frequency in hours
idAINodeSettingID of the AI Node Setting
aiNodeSettingNameAI Node Setting's name.
idCategoryCategory ID. Empty if uncategorized
statuseventTypeEvent Type
modelAI Model
Calculation parameters
AINodeSettingCalculationParams
sensitivityFactorControls how much to flatten probability distributions (0.0-10.0+, default 3.0)
minimumPercentagePerVariantMinimum percentage (0-30) each variant should get
capVariantPercentageMaximum percentage (50-100) any variant can have