Funnel Nodes

idNode

integer · int64 · min: 1 · required

64 bits integer unique id of the node

idFunnel

integer · int64 · min: 1 · required

64 bits integer id of the parent funnel

nodeName

string · required

nodeType

string · enum · required

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

Enum values:

root

rotator

lander

offer

externalUrl

jsCode

phpCode

condition

posX

number · double

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

Default: 0

posY

number · double

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

Default: 0

isArchived

boolean

Default: false

GET/data/campaign/funnel/node/find/byFunnel/index.php

curl --request GET \
  --url 'http://your_funnelflux_domain/admin/api/v2/data/campaign/funnel/node/find/byFunnel/index.php?apiKey=%3Cstring%3E&idFunnel=%3Cstring%3E'

Example Responses

[
  {
    "idNode": 1,
    "idFunnel": 1,
    "nodeName": "nodeName",
    "nodeType": "root",
    "nodeRotatorParams": {
      "rotatorType": "random"
    },
    "nodePageParams": {
      "idPage": 1,
      "accumulateUrlParams": false,
      "additionalTokens": [
        {
          "key": "key",
          "value": "value"
        }
      ]
    },
    "nodeExternalUrlParams": {
      "url": "url"
    },
    "nodeCodeParams": {
      "idCode": 1
    },
    "nodeConditionParams": {
      "idCondition": 1
    },
    "nodeVisitorTagParams": {
      "tags": [
        "string"
      ]
    },
    "posX": 0,
    "posY": 0,
    "isArchived": false
  }
]

json

application/json

Retrieve the specified node by its id

GET

http://YOUR_FUNNELFLUX_DOMAIN/admin/api/v2

/data/campaign/funnel/node/find/byId/index.php

Retrieve the specified node by its id

Retrieve the specified node by its id › query Parameters

apiKey

string · required

An authorized api key

idNode

string · required

Retrieve the specified node by its id › Responses

The requested funnel node

idNode

integer · int64 · min: 1 · required

64 bits integer unique id of the node

idFunnel

integer · int64 · min: 1 · required

64 bits integer id of the parent funnel

nodeName

string · required

nodeType

string · enum · required

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

Enum values:

root

rotator

lander

offer

externalUrl

jsCode

phpCode

condition

posX

number · double

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

Default: 0

posY

number · double

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

Default: 0

isArchived

boolean

Default: false

GET/data/campaign/funnel/node/find/byId/index.php

curl --request GET \
  --url 'http://your_funnelflux_domain/admin/api/v2/data/campaign/funnel/node/find/byId/index.php?apiKey=%3Cstring%3E&idNode=%3Cstring%3E'

Example Responses

{
  "idNode": 1,
  "idFunnel": 1,
  "nodeName": "nodeName",
  "nodeType": "root",
  "nodeRotatorParams": {
    "rotatorType": "random"
  },
  "nodePageParams": {
    "idPage": 1,
    "accumulateUrlParams": false,
    "additionalTokens": [
      {
        "key": "key",
        "value": "value"
      }
    ]
  },
  "nodeExternalUrlParams": {
    "url": "url"
  },
  "nodeCodeParams": {
    "idCode": 1
  },
  "nodeConditionParams": {
    "idCondition": 1
  },
  "nodeVisitorTagParams": {
    "tags": [
      "string"
    ]
  },
  "posX": 0,
  "posY": 0,
  "isArchived": false
}

json

application/json

Update an existing funnel node

PUT

http://YOUR_FUNNELFLUX_DOMAIN/admin/api/v2

/data/campaign/funnel/node/save/index.php

Update an existing funnel node. The id cannot be changed.

Update an existing funnel node › query Parameters

apiKey

string · required

An authorized api key

Update an existing funnel node › Request Body

idNode

integer · int64 · min: 1 · required

64 bits integer unique id of the node

idFunnel

integer · int64 · min: 1 · required

64 bits integer id of the parent funnel

nodeName

string · required

nodeType

string · enum · required

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

Enum values:

root

rotator

lander

offer

externalUrl

jsCode

phpCode

condition

posX

number · double

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

Default: 0

posY

number · double

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

Default: 0

isArchived

boolean

Default: false

Update an existing funnel node › Responses

Node updated successfully

No data returned

PUT/data/campaign/funnel/node/save/index.php

curl --request PUT \
  --url 'http://your_funnelflux_domain/admin/api/v2/data/campaign/funnel/node/save/index.php?apiKey=%3Cstring%3E' \
  --header 'Content-Type: application/json' \
  --data '
{
  "idNode": 1,
  "idFunnel": 1,
  "nodeName": "nodeName",
  "nodeType": "root",
  "nodeRotatorParams": {
    "rotatorType": "random"
  },
  "nodePageParams": {
    "idPage": 1,
    "accumulateUrlParams": false,
    "additionalTokens": [
      {
        "key": "key",
        "value": "value"
      }
    ]
  },
  "nodeExternalUrlParams": {
    "url": "url"
  },
  "nodeCodeParams": {
    "idCode": 1
  },
  "nodeConditionParams": {
    "idCondition": 1
  },
  "nodeVisitorTagParams": {
    "tags": [
      "string"
    ]
  },
  "posX": 0,
  "posY": 0,
  "isArchived": false
}
'

Example Request Body

{
  "idNode": 1,
  "idFunnel": 1,
  "nodeName": "nodeName",
  "nodeType": "root",
  "nodeRotatorParams": {
    "rotatorType": "random"
  },
  "nodePageParams": {
    "idPage": 1,
    "accumulateUrlParams": false,
    "additionalTokens": [
      {
        "key": "key",
        "value": "value"
      }
    ]
  },
  "nodeExternalUrlParams": {
    "url": "url"
  },
  "nodeCodeParams": {
    "idCode": 1
  },
  "nodeConditionParams": {
    "idCondition": 1
  },
  "nodeVisitorTagParams": {
    "tags": [
      "string"
    ]
  },
  "posX": 0,
  "posY": 0,
  "isArchived": false
}

json

Example Responses

No example specified for this content type

Create a new funnel node

POST

http://YOUR_FUNNELFLUX_DOMAIN/admin/api/v2

/data/campaign/funnel/node/save/index.php

Create a new funnel node

Create a new funnel node › query Parameters

apiKey

string · required

An authorized api key

Create a new funnel node › Request Body

idNode

integer · int64 · min: 1 · required

64 bits integer unique id of the node

idFunnel

integer · int64 · min: 1 · required

64 bits integer id of the parent funnel

nodeName

string · required

nodeType

string · enum · required

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

Enum values:

root

rotator

lander

offer

externalUrl

jsCode

phpCode

condition

Funnels Funnel Connections

posX

number · double

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

Default: 0

posY

number · double

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

Default: 0

isArchived

boolean

Default: false

Create a new funnel node › Responses

Node created successfully

No data returned

POST/data/campaign/funnel/node/save/index.php

curl --request POST \
  --url 'http://your_funnelflux_domain/admin/api/v2/data/campaign/funnel/node/save/index.php?apiKey=%3Cstring%3E' \
  --header 'Content-Type: application/json' \
  --data '
{
  "idNode": 1,
  "idFunnel": 1,
  "nodeName": "nodeName",
  "nodeType": "root",
  "nodeRotatorParams": {
    "rotatorType": "random"
  },
  "nodePageParams": {
    "idPage": 1,
    "accumulateUrlParams": false,
    "additionalTokens": [
      {
        "key": "key",
        "value": "value"
      }
    ]
  },
  "nodeExternalUrlParams": {
    "url": "url"
  },
  "nodeCodeParams": {
    "idCode": 1
  },
  "nodeConditionParams": {
    "idCondition": 1
  },
  "nodeVisitorTagParams": {
    "tags": [
      "string"
    ]
  },
  "posX": 0,
  "posY": 0,
  "isArchived": false
}
'

Example Request Body

{
  "idNode": 1,
  "idFunnel": 1,
  "nodeName": "nodeName",
  "nodeType": "root",
  "nodeRotatorParams": {
    "rotatorType": "random"
  },
  "nodePageParams": {
    "idPage": 1,
    "accumulateUrlParams": false,
    "additionalTokens": [
      {
        "key": "key",
        "value": "value"
      }
    ]
  },
  "nodeExternalUrlParams": {
    "url": "url"
  },
  "nodeCodeParams": {
    "idCode": 1
  },
  "nodeConditionParams": {
    "idCondition": 1
  },
  "nodeVisitorTagParams": {
    "tags": [
      "string"
    ]
  },
  "posX": 0,
  "posY": 0,
  "isArchived": false
}

json

Example Responses

No example specified for this content type

Delete the specified funnel node

DELETE

http://YOUR_FUNNELFLUX_DOMAIN/admin/api/v2

/data/campaign/funnel/node/delete/index.php

Delete the specified funnel node

Delete the specified funnel node › query Parameters

apiKey

string · required

An authorized api key

idNode

string · required

Delete the specified funnel node › Responses

Node deleted successfully

No data returned

FunnelFlux Data API

Funnel Nodes

Server

Download schema

Funnel nodes and node configuration.

Retrieve all nodes of the specified funnel

GET

http://YOUR_FUNNELFLUX_DOMAIN/admin/api/v2

/data/campaign/funnel/node/find/byFunnel/index.php

Retrieve all nodes of the specified funnel

Retrieve all nodes of the specified funnel › query Parameters

apiKey

string · required

An authorized api key

idFunnel

string · required

status

string · enum

Enum values:

active

archived

all

Retrieve all nodes of the specified funnel › Responses

List of funnel nodes

FunnelNode[]

idNode

integer · int64 · min: 1 · required

64 bits integer unique id of the node

idFunnel

integer · int64 · min: 1 · required

64 bits integer id of the parent funnel

nodeName

string · required

nodeType

string · enum · required

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

Enum values:

root

rotator

lander

offer

externalUrl

jsCode

phpCode

condition

posX

number · double

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

Default: 0

posY

number · double

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

Default: 0

isArchived

boolean

Default: false

GET/data/campaign/funnel/node/find/byFunnel/index.php

curl --request GET \
  --url 'http://your_funnelflux_domain/admin/api/v2/data/campaign/funnel/node/find/byFunnel/index.php?apiKey=%3Cstring%3E&idFunnel=%3Cstring%3E'

Example Responses

[
  {
    "idNode": 1,
    "idFunnel": 1,
    "nodeName": "nodeName",
    "nodeType": "root",
    "nodeRotatorParams": {
      "rotatorType": "random"
    },
    "nodePageParams": {
      "idPage": 1,
      "accumulateUrlParams": false,
      "additionalTokens": [
        {
          "key": "key",
          "value": "value"
        }
      ]
    },
    "nodeExternalUrlParams": {
      "url": "url"
    },
    "nodeCodeParams": {
      "idCode": 1
    },
    "nodeConditionParams": {
      "idCondition": 1
    },
    "nodeVisitorTagParams": {
      "tags": [
        "string"
      ]
    },
    "posX": 0,
    "posY": 0,
    "isArchived": false
  }
]

json

application/json

Retrieve the specified node by its id

GET

http://YOUR_FUNNELFLUX_DOMAIN/admin/api/v2

/data/campaign/funnel/node/find/byId/index.php

Retrieve the specified node by its id

Retrieve the specified node by its id › query Parameters

apiKey

string · required

An authorized api key

idNode

string · required

Retrieve the specified node by its id › Responses

The requested funnel node

idNode

integer · int64 · min: 1 · required

64 bits integer unique id of the node

idFunnel

integer · int64 · min: 1 · required

64 bits integer id of the parent funnel

nodeName

string · required

nodeType

string · enum · required

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

Enum values:

root

rotator

lander

offer

externalUrl

jsCode

phpCode

condition

posX

number · double

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

Default: 0

posY

number · double

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

Default: 0

isArchived

boolean

Default: false

GET/data/campaign/funnel/node/find/byId/index.php

curl --request GET \
  --url 'http://your_funnelflux_domain/admin/api/v2/data/campaign/funnel/node/find/byId/index.php?apiKey=%3Cstring%3E&idNode=%3Cstring%3E'

Example Responses

{
  "idNode": 1,
  "idFunnel": 1,
  "nodeName": "nodeName",
  "nodeType": "root",
  "nodeRotatorParams": {
    "rotatorType": "random"
  },
  "nodePageParams": {
    "idPage": 1,
    "accumulateUrlParams": false,
    "additionalTokens": [
      {
        "key": "key",
        "value": "value"
      }
    ]
  },
  "nodeExternalUrlParams": {
    "url": "url"
  },
  "nodeCodeParams": {
    "idCode": 1
  },
  "nodeConditionParams": {
    "idCondition": 1
  },
  "nodeVisitorTagParams": {
    "tags": [
      "string"
    ]
  },
  "posX": 0,
  "posY": 0,
  "isArchived": false
}

json

application/json

Update an existing funnel node

PUT

http://YOUR_FUNNELFLUX_DOMAIN/admin/api/v2

/data/campaign/funnel/node/save/index.php

Update an existing funnel node. The id cannot be changed.

Update an existing funnel node › query Parameters

apiKey

string · required

An authorized api key

Update an existing funnel node › Request Body

idNode

integer · int64 · min: 1 · required

64 bits integer unique id of the node

idFunnel

integer · int64 · min: 1 · required

64 bits integer id of the parent funnel

nodeName

string · required

nodeType

string · enum · required

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

Enum values:

root

rotator

lander

offer

externalUrl

jsCode

phpCode

condition

posX

number · double

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

Default: 0

posY

number · double

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

Default: 0

isArchived

boolean

Default: false

Update an existing funnel node › Responses

Node updated successfully

No data returned

PUT/data/campaign/funnel/node/save/index.php

curl --request PUT \
  --url 'http://your_funnelflux_domain/admin/api/v2/data/campaign/funnel/node/save/index.php?apiKey=%3Cstring%3E' \
  --header 'Content-Type: application/json' \
  --data '
{
  "idNode": 1,
  "idFunnel": 1,
  "nodeName": "nodeName",
  "nodeType": "root",
  "nodeRotatorParams": {
    "rotatorType": "random"
  },
  "nodePageParams": {
    "idPage": 1,
    "accumulateUrlParams": false,
    "additionalTokens": [
      {
        "key": "key",
        "value": "value"
      }
    ]
  },
  "nodeExternalUrlParams": {
    "url": "url"
  },
  "nodeCodeParams": {
    "idCode": 1
  },
  "nodeConditionParams": {
    "idCondition": 1
  },
  "nodeVisitorTagParams": {
    "tags": [
      "string"
    ]
  },
  "posX": 0,
  "posY": 0,
  "isArchived": false
}
'

Example Request Body

{
  "idNode": 1,
  "idFunnel": 1,
  "nodeName": "nodeName",
  "nodeType": "root",
  "nodeRotatorParams": {
    "rotatorType": "random"
  },
  "nodePageParams": {
    "idPage": 1,
    "accumulateUrlParams": false,
    "additionalTokens": [
      {
        "key": "key",
        "value": "value"
      }
    ]
  },
  "nodeExternalUrlParams": {
    "url": "url"
  },
  "nodeCodeParams": {
    "idCode": 1
  },
  "nodeConditionParams": {
    "idCondition": 1
  },
  "nodeVisitorTagParams": {
    "tags": [
      "string"
    ]
  },
  "posX": 0,
  "posY": 0,
  "isArchived": false
}

json

Example Responses

No example specified for this content type

Create a new funnel node

POST

http://YOUR_FUNNELFLUX_DOMAIN/admin/api/v2

/data/campaign/funnel/node/save/index.php

Create a new funnel node

Create a new funnel node › query Parameters

apiKey

string · required

An authorized api key

Create a new funnel node › Request Body

idNode

integer · int64 · min: 1 · required

64 bits integer unique id of the node

idFunnel

integer · int64 · min: 1 · required

64 bits integer id of the parent funnel

nodeName

string · required

nodeType

string · enum · required

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

Enum values:

root

rotator

lander

offer

externalUrl

jsCode

phpCode

condition