Schemas

64 bits integer id of the traffic filter

Traffic filter's name. 255 characters max.

The list of entries to filter against. If filterType = ipRanges, then each entry of the list must be formatted as 'rangeStart, rangeEnd', with a comma to separate the range's start and end. If filter type = knownBotsAndSpiders, then this list must be empty.

If set to an actual URL, then the filtered traffic is also redirected to that URL instead of flowing in the funnel

64 bits integer id of the offer source

Offer source's name. 255 characters max.

Name of the parameter to pass unique hit ids to your offer source

Which character is used to separate an offer's base url from its query parameters

Name of the subid parameter your offer source sends back to FunnelFlux when a conversion occurs

Name of the unique transaction id parameter your offer source sends back to FunnelFlux when a conversion occurs

Name of the payout parameter your offer source sends back to FunnelFlux when a conversion occurs

Caller-generated uint64 id for POST create (same pattern as other entities); required for PUT updates.

Offer source's name. 255 characters max.

Name of the parameter to pass unique hit ids to your offer source

Which character is used to separate an offer's base url from its query parameters

Name of the subid parameter your offer source sends back to FunnelFlux when a conversion occurs

Name of the unique transaction id parameter your offer source sends back to FunnelFlux when a conversion occurs

Name of the payout parameter your offer source sends back to FunnelFlux when a conversion occurs

64-bit traffic source id; caller-generated for POST create (same pattern as other entities).

Traffic source's name. 255 characters max.

The tracking field names and their associated default tokens

Read-only category name.

How the rotator will operate. If 'session', then one visitor will always follow the same route.

64 bits integer id of the lander or offer page

If true, then the accumulated URL params are forwarded to this node's url

Tokens to compute and then forward to this node's url

URL to redirect to

64 bits integer id of the code snippet

64 bits integer id of the condition

64 bits integer unique id of the node

64 bits integer id of the parent funnel

The 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 'jsCode' or 'phpCode' then the property 'nodeCodeParams' is required
• If nodeType is 'condition' then the property 'nodeConditionParams' is required
• If nodeType is 'visitorTag' then the property 'nodeVisitorTagParams' is required

Node's X position in the funnel canvas. From 0.0 to 1.0

Node's Y position in the funnel canvas. From 0.0 to 1.0

The connection weight from 0.0 to 1.0

'Action' number that will lead the visitor through this connection.

Determines if this action leads to a conversion of the source node offer

'Done' number that will lead the visitor through this connection.

The condition that must be true to follow that connection

64 bits integer unique id of the funnel

64 bits integer id of the parent funnel

64 bits integer id 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' or 'offer' then the property 'connectionPageParams' is required
• If source's nodeType is 'jsCode' or 'phpCode' then the property 'connectionCodeParams' is required
• If source's nodeType is 'condition' then the property 'connectionConditionParams' is required

64 bits integer id of the connection's target node

Connection's label's canvas 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.

Values to test against (as 'OR'). 'unknown' can be used to test for non-available data. If at least one test is true, the condition passes.

if 1 then today, if 2 then yesterday + today etc...

Depending on the selected test, some other properties may become required. >

• For test 'Time Date', testAgainstTimeDateParams is required
• For test 'Time Time of Day', testAgainstTimeOfDayParams is required
• For test 'Time Day of Week', testAgainstTimeDayOfWeekParams is required
• For test 'Time Day of Month', testAgainstTimeDayOfMonthParams is required
• For test 'Time Month of Year', testAgainstTimeMonthOfYearParams is required
• For test 'Conversion Cap Current Visitor', testAgainstVisitorConversionParams is required
• For test 'Conversion Cap Globally on Offer', testAgainstOfferConversionParams is required
• For test 'Tracking Field', testAgainstTrackingFieldParams is required
• For all other tests, testAgainstGenericParams is required

Test 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

All tests must be true for the condition to pass

64 bits integer id of the condition

At least one of those test blocks must be true for the condition to pass

If '', then can be used in all funnels, otherwise, id of the single funnel that can use this condition.

Duration in milliseconds to keep the javascript code snippet running

64 bits integer unique id of the funnel

If codeType = 'javascript' then codeJavascriptParams is required

64 bits integer unique id of the funnel

64 bits integer id of the parent campaign

Funnel's name. 255 characters max.

Width 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.

Height 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.

Default 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.

64 bits integer id of the campaign

Campaign'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

The KeyValuePair object is composed of >

• key - Url to be rewritten. Accepts wildcards *
• value - New rewritten url. Can be [[action:X]] to rewrite to a specific action. X being the action number

The KeyValuePair object is composed of >

• key - Content to be rewritten
• value - New rewritten content

Code to inject between and

Code to inject just before

List of referrers. One will be picked randomly from this list at each visit

List of user agents. One will be picked randomly from this list at each visit

true to enable cache, so the page is saved on the local server

true to enable direct traffic protection, so the page is only visible when coming from a tracking link

true to enable link rewriter. If true, then linkRewriterParams is required

true to enable content rewriter. If true, then contentRewriterParams is required

true to prevent videos from auto-playing

true to remove exit popups

true to block analytic scripts from recording FunnelFlux views

true to send fake referrer and user agents. If true, then referrerAndUASpooferParams is required

64 bits integer id of the offer's source.

Default payout amount

A tree having campaigns at the top level, funnels below campaigns, and nodes as leaves

64-bit page id; caller-generated for POST create (same pattern as other entities).

What kind of page. If 'offer' then 'offerParams' is required

Page's name. 255 characters max.

Redirects to this URL when page is displayed

How to redirect to the page's URL. 'umr' means 'Ultimate Meta Refresh'. 'fluxify' for cloaking the page with advanced settings. If 'fluxify' is used, then 'fluxifyParams' is required. By default, it uses the redirect type mentioned in the system settings for landers and offers.

List of tags assigned to the page. The category name is built from the tags, where each tag is separated by a dash.

Optional notes for this page

Category ID. Null or omit to uncategorize.

Category ID. Null or omit to uncategorize.