Funnel Connections

idConnection

integer · int64 · min: 1 · required

64 bits integer unique id of the funnel

idFunnel

integer · int64 · min: 1 · required

64 bits integer id of the parent funnel

idSourceNode

integer · int64 · min: 1 · required

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

idTargetNode

integer · int64 · min: 1 · required

64 bits integer id of the connection's target node

labelLocation

number · double

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.

Default: 0.5

Retrieve the specified connection by its id

GET

http://YOUR_FUNNELFLUX_DOMAIN/admin/api/v2

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

Retrieve the specified connection by its id

Retrieve the specified connection by its id › query Parameters

apiKey

string · required

An authorized api key

idConnection

string · required

Retrieve the specified connection by its id › Responses

The requested funnel connection

idConnection

integer · int64 · min: 1 · required

64 bits integer unique id of the funnel

idFunnel

integer · int64 · min: 1 · required

64 bits integer id of the parent funnel

idSourceNode

integer · int64 · min: 1 · required

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

idTargetNode

integer · int64 · min: 1 · required

64 bits integer id of the connection's target node

labelLocation

number · double

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.

Default: 0.5

Retrieve all the connections going out from the specified source node

GET

http://YOUR_FUNNELFLUX_DOMAIN/admin/api/v2

/data/campaign/funnel/connection/find/bySourceNodeId/index.php

Retrieve all the connections going out from the specified source node

Retrieve all the connections going out from the specified source node › query Parameters

apiKey

string · required

An authorized api key

idSourceNode

string · required

Retrieve all the connections going out from the specified source node › Responses

The funnel connections going out from the specified source node

idConnection

integer · int64 · min: 1 · required

64 bits integer unique id of the funnel

idFunnel

integer · int64 · min: 1 · required

64 bits integer id of the parent funnel

idSourceNode

integer · int64 · min: 1 · required

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

idTargetNode

integer · int64 · min: 1 · required

64 bits integer id of the connection's target node

labelLocation

number · double

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.

Default: 0.5

Retrieve all the connections going to the specified target node

GET

http://YOUR_FUNNELFLUX_DOMAIN/admin/api/v2

/data/campaign/funnel/connection/find/byTargetNodeId/index.php

Retrieve all the connections going to the specified target node

Retrieve all the connections going to the specified target node › query Parameters

apiKey

string · required

An authorized api key

idTargetNode

string · required

Retrieve all the connections going to the specified target node › Responses

The funnel connections going to the specified target node

idConnection

integer · int64 · min: 1 · required

64 bits integer unique id of the funnel

idFunnel

integer · int64 · min: 1 · required

64 bits integer id of the parent funnel

idSourceNode

integer · int64 · min: 1 · required

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

idTargetNode

integer · int64 · min: 1 · required

64 bits integer id of the connection's target node

labelLocation

number · double

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.

Default: 0.5

Update an existing funnel connection

PUT

http://YOUR_FUNNELFLUX_DOMAIN/admin/api/v2

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

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

Update an existing funnel connection › query Parameters

apiKey

string · required

An authorized api key

Update an existing funnel connection › Request Body

idConnection

integer · int64 · min: 1 · required

64 bits integer unique id of the funnel

idFunnel

integer · int64 · min: 1 · required

64 bits integer id of the parent funnel

idSourceNode

integer · int64 · min: 1 · required

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

idTargetNode

integer · int64 · min: 1 · required

64 bits integer id of the connection's target node

labelLocation

number · double

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.

Default: 0.5

Update an existing funnel connection › Responses

Connection updated successfully

No data returned

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

curl --request PUT \
  --url 'http://your_funnelflux_domain/admin/api/v2/data/campaign/funnel/connection/save/index.php?apiKey=%3Cstring%3E' \
  --header 'Content-Type: application/json' \
  --data '
{
  "idConnection": 1,
  "idFunnel": 1,
  "idSourceNode": 1,
  "idTargetNode": 1,
  "connectionRotatorParams": {
    "weight": 1
  },
  "connectionPageParams": {
    "onActionNumber": 1,
    "isConversion": false
  },
  "connectionCodeParams": {
    "onDoneNumber": 1
  },
  "connectionConditionParams": {
    "condition": "ifYes"
  },
  "labelLocation": 0.5
}
'

Example Request Body

{
  "idConnection": 1,
  "idFunnel": 1,
  "idSourceNode": 1,
  "idTargetNode": 1,
  "connectionRotatorParams": {
    "weight": 1
  },
  "connectionPageParams": {
    "onActionNumber": 1,
    "isConversion": false
  },
  "connectionCodeParams": {
    "onDoneNumber": 1
  },
  "connectionConditionParams": {
    "condition": "ifYes"
  },
  "labelLocation": 0.5
}

json

Example Responses

No example specified for this content type

Create a new funnel connection

POST

http://YOUR_FUNNELFLUX_DOMAIN/admin/api/v2

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

Create a new funnel connection

Create a new funnel connection › query Parameters

apiKey

string · required

An authorized api key

Create a new funnel connection › Request Body

idConnection

integer · int64 · min: 1 · required

64 bits integer unique id of the funnel

idFunnel

integer · int64 · min: 1 · required

64 bits integer id of the parent funnel

idSourceNode

integer · int64 · min: 1 · required

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

idTargetNode

integer · int64 · min: 1 · required

64 bits integer id of the connection's target node

Funnel Nodes Funnel Conditions

labelLocation

number · double

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.

Default: 0.5

Create a new funnel connection › Responses

Connection created successfully

No data returned

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

curl --request POST \
  --url 'http://your_funnelflux_domain/admin/api/v2/data/campaign/funnel/connection/save/index.php?apiKey=%3Cstring%3E' \
  --header 'Content-Type: application/json' \
  --data '
{
  "idConnection": 1,
  "idFunnel": 1,
  "idSourceNode": 1,
  "idTargetNode": 1,
  "connectionRotatorParams": {
    "weight": 1
  },
  "connectionPageParams": {
    "onActionNumber": 1,
    "isConversion": false
  },
  "connectionCodeParams": {
    "onDoneNumber": 1
  },
  "connectionConditionParams": {
    "condition": "ifYes"
  },
  "labelLocation": 0.5
}
'

Example Request Body

{
  "idConnection": 1,
  "idFunnel": 1,
  "idSourceNode": 1,
  "idTargetNode": 1,
  "connectionRotatorParams": {
    "weight": 1
  },
  "connectionPageParams": {
    "onActionNumber": 1,
    "isConversion": false
  },
  "connectionCodeParams": {
    "onDoneNumber": 1
  },
  "connectionConditionParams": {
    "condition": "ifYes"
  },
  "labelLocation": 0.5
}

json

Example Responses

No example specified for this content type

Delete the specified funnel connection

DELETE

http://YOUR_FUNNELFLUX_DOMAIN/admin/api/v2

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

Delete the specified funnel connection

Delete the specified funnel connection › query Parameters

apiKey

string · required

An authorized api key

idConnection

string · required

Delete the specified funnel connection › Responses

Connection deleted successfully

No data returned

FunnelFlux Data API

Funnel Connections

Server

Download schema

Connections between funnel nodes.

Retrieve all node connections of the specified funnel

GET

http://YOUR_FUNNELFLUX_DOMAIN/admin/api/v2

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

Retrieve all node connections of the specified funnel

Retrieve all node connections of the specified funnel › query Parameters

apiKey

string · required

An authorized api key

idFunnel

string · required

Retrieve all node connections of the specified funnel › Responses

List of funnel connections

idConnection

integer · int64 · min: 1 · required

64 bits integer unique id of the funnel

idFunnel

integer · int64 · min: 1 · required

64 bits integer id of the parent funnel

idSourceNode

integer · int64 · min: 1 · required

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

idTargetNode

integer · int64 · min: 1 · required

64 bits integer id of the connection's target node

labelLocation

number · double

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.

Default: 0.5

Retrieve the specified connection by its id

GET

http://YOUR_FUNNELFLUX_DOMAIN/admin/api/v2

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

Retrieve the specified connection by its id

Retrieve the specified connection by its id › query Parameters

apiKey

string · required

An authorized api key

idConnection

string · required

Retrieve the specified connection by its id › Responses

The requested funnel connection

idConnection

integer · int64 · min: 1 · required

64 bits integer unique id of the funnel

idFunnel

integer · int64 · min: 1 · required

64 bits integer id of the parent funnel

idSourceNode

integer · int64 · min: 1 · required

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

idTargetNode

integer · int64 · min: 1 · required

64 bits integer id of the connection's target node

labelLocation

number · double

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.

Default: 0.5

Retrieve all the connections going out from the specified source node

GET

http://YOUR_FUNNELFLUX_DOMAIN/admin/api/v2

/data/campaign/funnel/connection/find/bySourceNodeId/index.php

Retrieve all the connections going out from the specified source node

Retrieve all the connections going out from the specified source node › query Parameters

apiKey

string · required

An authorized api key

idSourceNode

string · required

Retrieve all the connections going out from the specified source node › Responses

The funnel connections going out from the specified source node

idConnection

integer · int64 · min: 1 · required

64 bits integer unique id of the funnel

idFunnel

integer · int64 · min: 1 · required

64 bits integer id of the parent funnel

idSourceNode

integer · int64 · min: 1 · required

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

idTargetNode

integer · int64 · min: 1 · required

64 bits integer id of the connection's target node

labelLocation

number · double

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.

Default: 0.5

Retrieve all the connections going to the specified target node

GET

http://YOUR_FUNNELFLUX_DOMAIN/admin/api/v2

/data/campaign/funnel/connection/find/byTargetNodeId/index.php

Retrieve all the connections going to the specified target node

Retrieve all the connections going to the specified target node › query Parameters

apiKey

string · required

An authorized api key

idTargetNode

string · required

Retrieve all the connections going to the specified target node › Responses

The funnel connections going to the specified target node

idConnection

integer · int64 · min: 1 · required

64 bits integer unique id of the funnel

idFunnel

integer · int64 · min: 1 · required

64 bits integer id of the parent funnel

idSourceNode

integer · int64 · min: 1 · required

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

idTargetNode

integer · int64 · min: 1 · required

64 bits integer id of the connection's target node

labelLocation

number · double

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.

Default: 0.5

Update an existing funnel connection

PUT

http://YOUR_FUNNELFLUX_DOMAIN/admin/api/v2

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

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

Update an existing funnel connection › query Parameters

apiKey

string · required

An authorized api key

Update an existing funnel connection › Request Body

idConnection

integer · int64 · min: 1 · required

64 bits integer unique id of the funnel

idFunnel

integer · int64 · min: 1 · required

64 bits integer id of the parent funnel

idSourceNode

integer · int64 · min: 1 · required

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

idTargetNode

integer · int64 · min: 1 · required

64 bits integer id of the connection's target node

labelLocation

number · double

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.

Default: 0.5

Update an existing funnel connection › Responses

Connection updated successfully

No data returned

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

curl --request PUT \
  --url 'http://your_funnelflux_domain/admin/api/v2/data/campaign/funnel/connection/save/index.php?apiKey=%3Cstring%3E' \
  --header 'Content-Type: application/json' \
  --data '
{
  "idConnection": 1,
  "idFunnel": 1,
  "idSourceNode": 1,
  "idTargetNode": 1,
  "connectionRotatorParams": {
    "weight": 1
  },
  "connectionPageParams": {
    "onActionNumber": 1,
    "isConversion": false
  },
  "connectionCodeParams": {
    "onDoneNumber": 1
  },
  "connectionConditionParams": {
    "condition": "ifYes"
  },
  "labelLocation": 0.5
}
'

Example Request Body

{
  "idConnection": 1,
  "idFunnel": 1,
  "idSourceNode": 1,
  "idTargetNode": 1,
  "connectionRotatorParams": {
    "weight": 1
  },
  "connectionPageParams": {
    "onActionNumber": 1,
    "isConversion": false
  },
  "connectionCodeParams": {
    "onDoneNumber": 1
  },
  "connectionConditionParams": {
    "condition": "ifYes"
  },
  "labelLocation": 0.5
}

json

Example Responses

No example specified for this content type

Create a new funnel connection

POST

http://YOUR_FUNNELFLUX_DOMAIN/admin/api/v2

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

Create a new funnel connection

Create a new funnel connection › query Parameters

apiKey

string · required

An authorized api key

Create a new funnel connection › Request Body

idConnection

integer · int64 · min: 1 · required

64 bits integer unique id of the funnel

idFunnel

integer · int64 · min: 1 · required

64 bits integer id of the parent funnel

idSourceNode

integer · int64 · min: 1 · required

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

idTargetNode

integer · int64 · min: 1 · required

64 bits integer id of the connection's target node