Schemas

Name for the new asset

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

Name for the new logic script.

Optional metadata overrides for the duplicated logic script. Only idCategory, categoryName, and description are honored; all other fields are ignored by the backend.

Name for the new funnel

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

ID of the newly created asset

ID of the category

Category's name.

ID of the offer source

Offer source's name.

ID of the parent category

Name of the parent category

ID of the offer source

Offer source's name.

Query parameters to add to the url. Tokens can be used as values.

Optional same-owner bare domain to use for UMR offer bounces.

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

Category ID. Empty if uncategorized

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.

ID of the category

Category's name.

ID of the traffic source

Traffic source's name.

ID of the parent category

Name of the parent category

ID of the traffic source

Traffic source's name.

DEPRECATED

Allowed keys are campaign, external and c1 to c20 - see example

Category ID. Empty if uncategorized

Free form object for storing custom scenario data (deprecated)

Free form object for storing conversion tracking settings (UI usage only)

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.

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

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

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

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

Webhook configs to dispatch for conversion events attributed to this traffic source

Map of custom event identifiers to webhook config IDs to dispatch for that event

Basic-auth username for middleware requests

Basic-auth password. Write a real value to create or replace it. REST read responses never return the stored value; when set they return the fixed placeholder ******** with hasBasicAuthPassword=true.

Absolute https destination URL (http is accepted only in a development environment). Edge revalidates the resolved host at execution time and blocks loopback, private, and metadata targets.

Additional request headers for middleware delivery. Header values can contain secrets and must be treated as sensitive.

Optional HMAC-SHA256 signing secret. Write a real value to create or replace it. REST read responses never return the stored value; when set they return the fixed placeholder ******** with hasHmacSecret=true.

Read-state flag returned by REST read endpoints when a non-blank basic-auth password is stored. On save, send true with an omitted, blank, or ******** password to preserve the existing stored password.

Read-state flag returned by REST read endpoints when a non-blank HMAC secret is stored. On save, send true with omitted, blank, or ******** hmacSecret to preserve the existing stored secret.

Use status_code, body_text, or body_json.<path>. body_json paths use backend-supported dot segments only, for example body_json.decision or body_json.items.0.score; brackets, quotes, JSONPath syntax, spaces, empty segments, leading/trailing dots, and double dots are rejected. Response bodies are capped at 64 KiB before body_text/body_json evaluation.

status_code values must be integer HTTP status codes from 100 to 599 with no signs, decimals, padding, or spaces. Exact is and is_not comparisons are currently case-insensitive. contains and not_contains are case-insensitive. Numeric comparisons require a finite numeric value and are valid for status_code and body_json.<path>.

Required for is, is_not, contains, not_contains, and numeric comparison operators.

Stable lowercase route key. This is also the user-facing route label. Use default for the default route.

Route evaluation order. Default route must use 0; non-default routes must use 1..255.

Empty for the default route; non-default routes require at least one condition.

ID of the middleware configuration

Middleware config's name.

Exactly one route must be marked isDefault. Non-default routes are evaluated in ascending priority order. Route idRoute values are stable lowercase keys and are also the user-facing labels.

Middleware config schema version.

Category ID. Empty if uncategorized.

Category ID. Empty if uncategorized.

ID of the webhook configuration

Webhook config's name.

Category ID. Empty if uncategorized

Whether delivery is enabled for this webhook config

Absolute webhook destination URL

Additional request headers for webhook delivery

ID of the webhook configuration

Webhook config's name.

Category ID. Empty if uncategorized

Whether delivery is enabled for this webhook config

Absolute webhook destination URL

Additional request headers for webhook delivery

Basic auth read model. Password is write-only and never returned by REST read endpoints.

Category ID. Empty if uncategorized

Parent IDs to delete or archive. Delete endpoints also keep their legacy query-ID fallback.

Optional child handling action. Omit to preserve each endpoint's existing behavior.

Required when cascadeAction is move. Rejected for other actions.

List of asset IDs to move

Target category ID (empty string to remove from category)

List of global page group IDs to move

Target category ID (empty string to remove from category)

Page-group category type

DEPRECATED

How the rotator will operate. Defaults to "random" (weighted random selection across outgoing connections). Use "ai" only for AI-optimised rotation.

Controls 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

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

Allows to override a page's default redirectType

URL to redirect to

What http code should be used to redirect to the external URL.

ID of the condition

ID of the logic script asset executed by this logic node.

Tag IDs to add to the visitor

Tag IDs to remove from the visitor

Webhook configs to execute

Node-level request headers for middleware delivery. Duplicate header names replace the middleware config header value; new header names are appended.

Optional node-level HMAC-SHA256 signing secret. Write a real value to create or replace it. REST read responses never return the stored value; when set they return the fixed placeholder ******** with hasHmacSecret=true.

Read-state flag returned by REST read endpoints when a non-blank node-level basic-auth password is stored. On save, send true with an omitted, blank, or ******** password to preserve the existing stored password.

Read-state flag returned by REST read endpoints when a non-blank node-level HMAC secret is stored. On save, send true with omitted, blank, or ******** hmacSecret to preserve the existing stored secret.

Middleware config asset executed by this middleware node.

ID of the page group

Optional advanced per-page settings (e.g. accumulateUrlParams, redirect override, additional tokens) for individual pages in the referenced group, keyed by page. This does NOT control which pages are served or rotated; that is determined by the page group's own pages list. Omit it entirely to apply defaults to every page in the group.

The text to display on the label

A hex code for the label's background color

Page group's name.

Type of pages in this group (lander or offer)

ID of the category

Name of the parent category

Page group's name.

What kind of pages in this group.

List of page entries

Category ID for global page groups. Empty string means Uncategorized.

Category display name paired with idCategory. Uncategorized is returned when idCategory is empty.

If 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. Local (funnel-scoped) page groups are excluded from global list endpoints and the UI's global page-group lists; they remain fully functional and can still be fetched directly by ID.

Controls 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

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.

The page's weight from 0.0 to 1.0

ID of the node

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 (only set it for a non-default stickinessMode or AI rotation; otherwise rotation defaults to weighted/random and targets are derived from the outgoing connections)
• 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 'logic' then the property 'nodeLogicParams' 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 'webhook' then the property 'nodeWebhookRefParams' is required
• If nodeType is 'middleware' then the property 'nodeMiddlewareRefParams' is required and outgoing connections use connectionMiddlewareParams.onRouteId
• 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

Optional for root and rotator nodes. Only needed when you want a non-default stickinessMode or AI-driven rotation (rotatorType "ai"). When omitted, rotation defaults to weighted/random and the rotation targets are derived from the node's outgoing connections.

Node's X position in the funnel canvas.

Node's Y position in the funnel canvas.

Whether the node is global or not

The connection weight from 0.0 to 1.0

The array of 'Action' numbers that will lead the visitor through this connection.

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

Inline conversion specs for this connection

Determines if this action leads to a custom event of the source page node

Inline custom event specs for this connection

Webhook configs to dispatch when this action connection is selected

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

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.

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

Route keys selected by a source logic node that should follow this connection. Each key must match ^[a-z0-9_]{1,64}$. Multiple route keys may map to this same visual connection and target node. "default" is reserved for runtime fallback when present, but is not required.

Middleware config route idRoute that should follow this connection. Use default for the default route.

Inline conversion specs for this middleware route connection

Inline custom event specs for this middleware route connection

Determines if this middleware route records a conversion

Determines if this middleware route records a custom event

The array of 'Action' numbers that will lead the visitor through this connection.

Webhook configs to dispatch when this action-proxy connection is selected

ID of the funnel

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', '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 'logic' then the property 'connectionLogicParams' is required
• If source's nodeType is 'middleware' then the property 'connectionMiddlewareParams' is required
• If source's nodeType is 'actionProxy' then the property 'connectionActionProxyParams' is required

ID of the connection's target node

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

Values to test against

Visitor tag ID to test against the current visitor/session tag set

UTC offset in minutes for timezone-aware evaluation. If not set, uses visitor timezone.

UTC offset in minutes for timezone-aware evaluation. If not set, uses visitor timezone.

UTC offset in minutes for timezone-aware evaluation. If not set, uses visitor timezone.

UTC offset in minutes for timezone-aware evaluation. If not set, uses visitor timezone.

UTC offset in minutes for timezone-aware evaluation. If not set, uses visitor timezone.

Depending 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

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

Human-readable route name. In V2, Default Route is reserved for the default route only.

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.

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

ID of the condition

Category ID. Empty if uncategorized

If empty, then can be used in all funnels, otherwise, id of the funnel that can use this condition. A funnel-scoped (local) condition is hidden from global condition lists and the UI but remains usable and fetchable by ID.

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.

ID of the condition's category

Category's name.

ID of the condition

Condition's name.

ID of the parent category

Name of the parent category

ID of the logic script.

Logic script display name. The backend trims and validates non-empty names.

Logic script code. Maximum size is 10 KB.

Server-managed SHA-256 hash of code. Omit on create/update/duplicate bodyUpdates.

Lifecycle status. Defaults to active when omitted on write.

Server-managed owner. Omit on writes.

Category ID. Empty if uncategorized.

Optional user-facing description.

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.

ID of the logic script.

Logic script display name.

ID of the parent category.

Name of the parent category.

Server-managed SHA-256 hash of code when returned by the backend.

ID of the tag

Tag name

Display color for the tag

Category ID for organizing tags

Category name for organizing tags

ID of the funnel

ID of the parent campaign (legacy alias for idFunnelGroup)

Funnel's name.

ID of the parent funnel group

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

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

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

ID of the campaign

Campaign's name.

ID of the funnel

Funnel's name.

ID of the parent funnel group

Name of the parent funnel group

ID of the campaign

Campaign's name.

Query parameters to add to the tracking url for all the funnels of this campaign, unless a specific funnel overwrites them

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.

ID of the funnel group

Funnel group's name.

ID of the funnel group

Funnel 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

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.

ID of the offer's source.

Default payout amount

Optional same-owner bare domain to use for this offer's UMR bounces. Takes priority over the offer source override.

Enables direct page-visit default funnel attribution for this page.

Active funnel to use when this page URL is visited directly through /js/funnel without explicit funnel context.

Node in the default funnel that represents this page directly or through a page group containing this page.

Traffic source for the default entrance. Empty defaults to organic.

ID of category. Use an empty string on assets to mean no category; empty string is not a persisted category row.

Category name

Category type

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.

ID of the category

Category's name.

ID of the page

Page's name.

ID of the category

Type of page (lander or offer)

ID of the offer source for offer pages

Name of the parent category

Name of the offer source for offer pages

ID of the page

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

Page's name.

Redirects to this URL when page is displayed

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

Category ID. Empty if uncategorized

Optional notes for this page

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.

Whether the page can be append visitor id or not.

URL of default homepage, keep empty for 404 response

Default redirect type for offers. See more about types in Page.redirectType description

Default redirect type for landers. See more about types in Page.redirectType description

IP Anonymizer name

Default custom domain name from 'customDomains' collection

Keys from third parties

Custom event number to alias mappings for reporting

Alias for the custom event

Short alias for the custom event

Generated API key

API that can be used with given key

API key name

API that can be used with given key