Funnel Conditions

Server

Download schema

Funnel routing conditions.

Retrieve a condition by its id

GET

http://YOUR_FUNNELFLUX_DOMAIN/admin/api/v2

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

Retrieve a condition by its id

Retrieve a condition by its id › query Parameters

apiKey

string · required

An authorized api key

idCondition

string · required

Retrieve a condition by its id › Responses

The requested condition

FunnelCondition

idCondition

integer · int64 · min: 1 · required

64 bits integer id of the condition

conditionName

string · required

FunnelConditionTestsBlock[] · required

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

restrictToFunnelId

string

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

Default:

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

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

Example Responses

{
  "idCondition": 1,
  "conditionName": "conditionName",
  "orTests": [
    {
      "andTests": [
        {
          "test": "Location: Continent",
          "operator": "IS",
          "testAgainstGenericParams": {
            "values": [
              "string"
            ]
          },
          "testAgainstTimeDateParams": {
            "date": {
              "year": 1970,
              "month": 1,
              "day": 1
            }
          },
          "testAgainstTimeOfDayParams": {
            "time": {
              "hour": 0,
              "minutes": 0
            }
          },
          "testAgainstTimeDayOfWeekParams": {
            "day": "sunday"
          },
          "testAgainstTimeDayOfMonthParams": {
            "day": 1
          },
          "testAgainstTimeMonthOfYearParams": {
            "month": "january"
          },
          "testAgainstVisitorConversionParams": {
            "idOffer": "idOffer",
            "conversionsCount": "conversionsCount"
          },
          "testAgainstOfferConversionParams": {
            "idOffer": "idOffer",
            "conversionsCount": "conversionsCount",
            "lastXDays": 1
          },
          "testAgainstTrackingFieldParams": {
            "trackingField": "trackingField",
            "values": [
              "string"
            ]
          }
        }
      ]
    }
  ],
  "restrictToFunnelId": ""
}

json

application/json

Retrieve a condition by its name

GET

http://YOUR_FUNNELFLUX_DOMAIN/admin/api/v2

/data/campaign/funnel/condition/find/byName/index.php

Retrieve a condition by its name

Retrieve a condition by its name › query Parameters

apiKey

string · required

An authorized api key

name

string · required

Retrieve a condition by its name › Responses

The requested condition

FunnelCondition

idCondition

integer · int64 · min: 1 · required

64 bits integer id of the condition

conditionName

string · required

FunnelConditionTestsBlock[] · required

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

restrictToFunnelId

string

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

Default:

GET/data/campaign/funnel/condition/find/byName/index.php

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

Example Responses

{
  "idCondition": 1,
  "conditionName": "conditionName",
  "orTests": [
    {
      "andTests": [
        {
          "test": "Location: Continent",
          "operator": "IS",
          "testAgainstGenericParams": {
            "values": [
              "string"
            ]
          },
          "testAgainstTimeDateParams": {
            "date": {
              "year": 1970,
              "month": 1,
              "day": 1
            }
          },
          "testAgainstTimeOfDayParams": {
            "time": {
              "hour": 0,
              "minutes": 0
            }
          },
          "testAgainstTimeDayOfWeekParams": {
            "day": "sunday"
          },
          "testAgainstTimeDayOfMonthParams": {
            "day": 1
          },
          "testAgainstTimeMonthOfYearParams": {
            "month": "january"
          },
          "testAgainstVisitorConversionParams": {
            "idOffer": "idOffer",
            "conversionsCount": "conversionsCount"
          },
          "testAgainstOfferConversionParams": {
            "idOffer": "idOffer",
            "conversionsCount": "conversionsCount",
            "lastXDays": 1
          },
          "testAgainstTrackingFieldParams": {
            "trackingField": "trackingField",
            "values": [
              "string"
            ]
          }
        }
      ]
    }
  ],
  "restrictToFunnelId": ""
}

json

application/json

Update an existing condition

PUT

http://YOUR_FUNNELFLUX_DOMAIN/admin/api/v2

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

Update an existing condition. The id cannot be changed.

Update an existing condition › query Parameters

apiKey

string · required

An authorized api key

Update an existing condition › Request Body

FunnelCondition

idCondition

integer · int64 · min: 1 · required

64 bits integer id of the condition

conditionName

string · required

FunnelConditionTestsBlock[] · required

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

restrictToFunnelId

string

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

Default:

Update an existing condition › Responses

Condition updated successfully

No data returned

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

curl --request PUT \
  --url 'http://your_funnelflux_domain/admin/api/v2/data/campaign/funnel/condition/save/index.php?apiKey=%3Cstring%3E' \
  --header 'Content-Type: application/json' \
  --data '
{
  "idCondition": 1,
  "conditionName": "conditionName",
  "orTests": [
    {
      "andTests": [
        {
          "test": "Location: Continent",
          "operator": "IS",
          "testAgainstGenericParams": {
            "values": [
              "string"
            ]
          },
          "testAgainstTimeDateParams": {
            "date": {
              "year": 1970,
              "month": 1,
              "day": 1
            }
          },
          "testAgainstTimeOfDayParams": {
            "time": {
              "hour": 0,
              "minutes": 0
            }
          },
          "testAgainstTimeDayOfWeekParams": {
            "day": "sunday"
          },
          "testAgainstTimeDayOfMonthParams": {
            "day": 1
          },
          "testAgainstTimeMonthOfYearParams": {
            "month": "january"
          },
          "testAgainstVisitorConversionParams": {
            "idOffer": "idOffer",
            "conversionsCount": "conversionsCount"
          },
          "testAgainstOfferConversionParams": {
            "idOffer": "idOffer",
            "conversionsCount": "conversionsCount",
            "lastXDays": 1
          },
          "testAgainstTrackingFieldParams": {
            "trackingField": "trackingField",
            "values": [
              "string"
            ]
          }
        }
      ]
    }
  ],
  "restrictToFunnelId": ""
}
'

Example Request Body

{
  "idCondition": 1,
  "conditionName": "conditionName",
  "orTests": [
    {
      "andTests": [
        {
          "test": "Location: Continent",
          "operator": "IS",
          "testAgainstGenericParams": {
            "values": [
              "string"
            ]
          },
          "testAgainstTimeDateParams": {
            "date": {
              "year": 1970,
              "month": 1,
              "day": 1
            }
          },
          "testAgainstTimeOfDayParams": {
            "time": {
              "hour": 0,
              "minutes": 0
            }
          },
          "testAgainstTimeDayOfWeekParams": {
            "day": "sunday"
          },
          "testAgainstTimeDayOfMonthParams": {
            "day": 1
          },
          "testAgainstTimeMonthOfYearParams": {
            "month": "january"
          },
          "testAgainstVisitorConversionParams": {
            "idOffer": "idOffer",
            "conversionsCount": "conversionsCount"
          },
          "testAgainstOfferConversionParams": {
            "idOffer": "idOffer",
            "conversionsCount": "conversionsCount",
            "lastXDays": 1
          },
          "testAgainstTrackingFieldParams": {
            "trackingField": "trackingField",
            "values": [
              "string"
            ]
          }
        }
      ]
    }
  ],
  "restrictToFunnelId": ""
}

json

Example Responses

No example specified for this content type

Create a new condition

POST

http://YOUR_FUNNELFLUX_DOMAIN/admin/api/v2

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

Create a new condition

Create a new condition › query Parameters

apiKey

string · required

An authorized api key

Create a new condition › Request Body

FunnelCondition

idCondition

integer · int64 · min: 1 · required

64 bits integer id of the condition

conditionName

string · required

FunnelConditionTestsBlock[] · required

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

restrictToFunnelId

string

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

Default:

Create a new condition › Responses

Condition created successfully

No data returned

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

curl --request POST \
  --url 'http://your_funnelflux_domain/admin/api/v2/data/campaign/funnel/condition/save/index.php?apiKey=%3Cstring%3E' \
  --header 'Content-Type: application/json' \
  --data '
{
  "idCondition": 1,
  "conditionName": "conditionName",
  "orTests": [
    {
      "andTests": [
        {
          "test": "Location: Continent",
          "operator": "IS",
          "testAgainstGenericParams": {
            "values": [
              "string"
            ]
          },
          "testAgainstTimeDateParams": {
            "date": {
              "year": 1970,
              "month": 1,
              "day": 1
            }
          },
          "testAgainstTimeOfDayParams": {
            "time": {
              "hour": 0,
              "minutes": 0
            }
          },
          "testAgainstTimeDayOfWeekParams": {
            "day": "sunday"
          },
          "testAgainstTimeDayOfMonthParams": {
            "day": 1
          },
          "testAgainstTimeMonthOfYearParams": {
            "month": "january"
          },
          "testAgainstVisitorConversionParams": {
            "idOffer": "idOffer",
            "conversionsCount": "conversionsCount"
          },
          "testAgainstOfferConversionParams": {
            "idOffer": "idOffer",
            "conversionsCount": "conversionsCount",
            "lastXDays": 1
          },
          "testAgainstTrackingFieldParams": {
            "trackingField": "trackingField",
            "values": [
              "string"
            ]
          }
        }
      ]
    }
  ],
  "restrictToFunnelId": ""
}
'

Example Request Body

{
  "idCondition": 1,
  "conditionName": "conditionName",
  "orTests": [
    {
      "andTests": [
        {
          "test": "Location: Continent",
          "operator": "IS",
          "testAgainstGenericParams": {
            "values": [
              "string"
            ]
          },
          "testAgainstTimeDateParams": {
            "date": {
              "year": 1970,
              "month": 1,
              "day": 1
            }
          },
          "testAgainstTimeOfDayParams": {
            "time": {
              "hour": 0,
              "minutes": 0
            }
          },
          "testAgainstTimeDayOfWeekParams": {
            "day": "sunday"
          },
          "testAgainstTimeDayOfMonthParams": {
            "day": 1
          },
          "testAgainstTimeMonthOfYearParams": {
            "month": "january"
          },
          "testAgainstVisitorConversionParams": {
            "idOffer": "idOffer",
            "conversionsCount": "conversionsCount"
          },
          "testAgainstOfferConversionParams": {
            "idOffer": "idOffer",
            "conversionsCount": "conversionsCount",
            "lastXDays": 1
          },
          "testAgainstTrackingFieldParams": {
            "trackingField": "trackingField",
            "values": [
              "string"
            ]
          }
        }
      ]
    }
  ],
  "restrictToFunnelId": ""
}

json

Example Responses

No example specified for this content type

Delete the specified condition

DELETE

http://YOUR_FUNNELFLUX_DOMAIN/admin/api/v2

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

Delete the specified condition

Delete the specified condition › query Parameters

apiKey

string · required

An authorized api key

idCondition

string · required

Delete the specified condition › Responses

Condition deleted successfully

No data returned

Get a list of all conditions as id/name pairs

GET

http://YOUR_FUNNELFLUX_DOMAIN/admin/api/v2

/data/campaign/funnel/condition/list/index.php

Get a list of all conditions as id/name pairs

Get a list of all conditions as id/name pairs › query Parameters

apiKey

string · required

An authorized api key

Get a list of all conditions as id/name pairs › Responses

List of conditions

IdNamePair[]

IdNamePair

id

integer · int64

name

string

Funnel Connections Funnel Code Snippets

FunnelFlux Data API

Funnel Conditions

Server

Download schema

Funnel routing conditions.

Retrieve a condition by its id

GET

http://YOUR_FUNNELFLUX_DOMAIN/admin/api/v2

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

Retrieve a condition by its id

Retrieve a condition by its id › query Parameters

apiKey

string · required

An authorized api key

idCondition

string · required

Retrieve a condition by its id › Responses

The requested condition

FunnelCondition

idCondition

integer · int64 · min: 1 · required

64 bits integer id of the condition

conditionName

string · required

FunnelConditionTestsBlock[] · required

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

restrictToFunnelId

string

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

Default:

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

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

Example Responses

{
  "idCondition": 1,
  "conditionName": "conditionName",
  "orTests": [
    {
      "andTests": [
        {
          "test": "Location: Continent",
          "operator": "IS",
          "testAgainstGenericParams": {
            "values": [
              "string"
            ]
          },
          "testAgainstTimeDateParams": {
            "date": {
              "year": 1970,
              "month": 1,
              "day": 1
            }
          },
          "testAgainstTimeOfDayParams": {
            "time": {
              "hour": 0,
              "minutes": 0
            }
          },
          "testAgainstTimeDayOfWeekParams": {
            "day": "sunday"
          },
          "testAgainstTimeDayOfMonthParams": {
            "day": 1
          },
          "testAgainstTimeMonthOfYearParams": {
            "month": "january"
          },
          "testAgainstVisitorConversionParams": {
            "idOffer": "idOffer",
            "conversionsCount": "conversionsCount"
          },
          "testAgainstOfferConversionParams": {
            "idOffer": "idOffer",
            "conversionsCount": "conversionsCount",
            "lastXDays": 1
          },
          "testAgainstTrackingFieldParams": {
            "trackingField": "trackingField",
            "values": [
              "string"
            ]
          }
        }
      ]
    }
  ],
  "restrictToFunnelId": ""
}

json

application/json

Retrieve a condition by its name

GET

http://YOUR_FUNNELFLUX_DOMAIN/admin/api/v2

/data/campaign/funnel/condition/find/byName/index.php

Retrieve a condition by its name

Retrieve a condition by its name › query Parameters

apiKey

string · required

An authorized api key

name

string · required

Retrieve a condition by its name › Responses

The requested condition

FunnelCondition

idCondition

integer · int64 · min: 1 · required

64 bits integer id of the condition

conditionName

string · required

FunnelConditionTestsBlock[] · required

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

restrictToFunnelId

string

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

Default:

GET/data/campaign/funnel/condition/find/byName/index.php

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

Example Responses

{
  "idCondition": 1,
  "conditionName": "conditionName",
  "orTests": [
    {
      "andTests": [
        {
          "test": "Location: Continent",
          "operator": "IS",
          "testAgainstGenericParams": {
            "values": [
              "string"
            ]
          },
          "testAgainstTimeDateParams": {
            "date": {
              "year": 1970,
              "month": 1,
              "day": 1
            }
          },
          "testAgainstTimeOfDayParams": {
            "time": {
              "hour": 0,
              "minutes": 0
            }
          },
          "testAgainstTimeDayOfWeekParams": {
            "day": "sunday"
          },
          "testAgainstTimeDayOfMonthParams": {
            "day": 1
          },
          "testAgainstTimeMonthOfYearParams": {
            "month": "january"
          },
          "testAgainstVisitorConversionParams": {
            "idOffer": "idOffer",
            "conversionsCount": "conversionsCount"
          },
          "testAgainstOfferConversionParams": {
            "idOffer": "idOffer",
            "conversionsCount": "conversionsCount",
            "lastXDays": 1
          },
          "testAgainstTrackingFieldParams": {
            "trackingField": "trackingField",
            "values": [
              "string"
            ]
          }
        }
      ]
    }
  ],
  "restrictToFunnelId": ""
}

json

application/json

Update an existing condition

PUT

http://YOUR_FUNNELFLUX_DOMAIN/admin/api/v2

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

Update an existing condition. The id cannot be changed.

Update an existing condition › query Parameters

apiKey

string · required

An authorized api key

Update an existing condition › Request Body

FunnelCondition

idCondition

integer · int64 · min: 1 · required

64 bits integer id of the condition

conditionName

string · required

FunnelConditionTestsBlock[] · required

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

restrictToFunnelId

string

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

Default:

Update an existing condition › Responses

Condition updated successfully

No data returned

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

curl --request PUT \
  --url 'http://your_funnelflux_domain/admin/api/v2/data/campaign/funnel/condition/save/index.php?apiKey=%3Cstring%3E' \
  --header 'Content-Type: application/json' \
  --data '
{
  "idCondition": 1,
  "conditionName": "conditionName",
  "orTests": [
    {
      "andTests": [
        {
          "test": "Location: Continent",
          "operator": "IS",
          "testAgainstGenericParams": {
            "values": [
              "string"
            ]
          },
          "testAgainstTimeDateParams": {
            "date": {
              "year": 1970,
              "month": 1,
              "day": 1
            }
          },
          "testAgainstTimeOfDayParams": {
            "time": {
              "hour": 0,
              "minutes": 0
            }
          },
          "testAgainstTimeDayOfWeekParams": {
            "day": "sunday"
          },
          "testAgainstTimeDayOfMonthParams": {
            "day": 1
          },
          "testAgainstTimeMonthOfYearParams": {
            "month": "january"
          },
          "testAgainstVisitorConversionParams": {
            "idOffer": "idOffer",
            "conversionsCount": "conversionsCount"
          },
          "testAgainstOfferConversionParams": {
            "idOffer": "idOffer",
            "conversionsCount": "conversionsCount",
            "lastXDays": 1
          },
          "testAgainstTrackingFieldParams": {
            "trackingField": "trackingField",
            "values": [
              "string"
            ]
          }
        }
      ]
    }
  ],
  "restrictToFunnelId": ""
}
'

Example Request Body

{
  "idCondition": 1,
  "conditionName": "conditionName",
  "orTests": [
    {
      "andTests": [
        {
          "test": "Location: Continent",
          "operator": "IS",
          "testAgainstGenericParams": {
            "values": [
              "string"
            ]
          },
          "testAgainstTimeDateParams": {
            "date": {
              "year": 1970,
              "month": 1,
              "day": 1
            }
          },
          "testAgainstTimeOfDayParams": {
            "time": {
              "hour": 0,
              "minutes": 0
            }
          },
          "testAgainstTimeDayOfWeekParams": {
            "day": "sunday"
          },
          "testAgainstTimeDayOfMonthParams": {
            "day": 1
          },
          "testAgainstTimeMonthOfYearParams": {
            "month": "january"
          },
          "testAgainstVisitorConversionParams": {
            "idOffer": "idOffer",
            "conversionsCount": "conversionsCount"
          },
          "testAgainstOfferConversionParams": {
            "idOffer": "idOffer",
            "conversionsCount": "conversionsCount",
            "lastXDays": 1
          },
          "testAgainstTrackingFieldParams": {
            "trackingField": "trackingField",
            "values": [
              "string"
            ]
          }
        }
      ]
    }
  ],
  "restrictToFunnelId": ""
}

json

Example Responses

No example specified for this content type

Create a new condition

POST

http://YOUR_FUNNELFLUX_DOMAIN/admin/api/v2

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

Create a new condition

Create a new condition › query Parameters

apiKey

string · required

An authorized api key

Create a new condition › Request Body

FunnelCondition

idCondition

integer · int64 · min: 1 · required

64 bits integer id of the condition

conditionName

string · required

FunnelConditionTestsBlock[] · required

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

restrictToFunnelId

string

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

Default:

Create a new condition › Responses

Condition created successfully

No data returned

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

curl --request POST \
  --url 'http://your_funnelflux_domain/admin/api/v2/data/campaign/funnel/condition/save/index.php?apiKey=%3Cstring%3E' \
  --header 'Content-Type: application/json' \
  --data '
{
  "idCondition": 1,
  "conditionName": "conditionName",
  "orTests": [
    {
      "andTests": [
        {
          "test": "Location: Continent",
          "operator": "IS",
          "testAgainstGenericParams": {
            "values": [
              "string"
            ]
          },
          "testAgainstTimeDateParams": {
            "date": {
              "year": 1970,
              "month": 1,
              "day": 1
            }
          },
          "testAgainstTimeOfDayParams": {
            "time": {
              "hour": 0,
              "minutes": 0
            }
          },
          "testAgainstTimeDayOfWeekParams": {
            "day": "sunday"
          },
          "testAgainstTimeDayOfMonthParams": {
            "day": 1
          },
          "testAgainstTimeMonthOfYearParams": {
            "month": "january"
          },
          "testAgainstVisitorConversionParams": {
            "idOffer": "idOffer",
            "conversionsCount": "conversionsCount"
          },
          "testAgainstOfferConversionParams": {
            "idOffer": "idOffer",
            "conversionsCount": "conversionsCount",
            "lastXDays": 1
          },
          "testAgainstTrackingFieldParams": {
            "trackingField": "trackingField",
            "values": [
              "string"
            ]
          }
        }
      ]
    }
  ],
  "restrictToFunnelId": ""
}
'

Example Request Body

{
  "idCondition": 1,
  "conditionName": "conditionName",
  "orTests": [
    {
      "andTests": [
        {
          "test": "Location: Continent",
          "operator": "IS",
          "testAgainstGenericParams": {
            "values": [
              "string"
            ]
          },
          "testAgainstTimeDateParams": {
            "date": {
              "year": 1970,
              "month": 1,
              "day": 1
            }
          },
          "testAgainstTimeOfDayParams": {
            "time": {
              "hour": 0,
              "minutes": 0
            }
          },
          "testAgainstTimeDayOfWeekParams": {
            "day": "sunday"
          },
          "testAgainstTimeDayOfMonthParams": {
            "day": 1
          },
          "testAgainstTimeMonthOfYearParams": {
            "month": "january"
          },
          "testAgainstVisitorConversionParams": {
            "idOffer": "idOffer",
            "conversionsCount": "conversionsCount"
          },
          "testAgainstOfferConversionParams": {
            "idOffer": "idOffer",
            "conversionsCount": "conversionsCount",
            "lastXDays": 1
          },
          "testAgainstTrackingFieldParams": {
            "trackingField": "trackingField",
            "values": [
              "string"
            ]
          }
        }
      ]
    }
  ],
  "restrictToFunnelId": ""
}

json

Example Responses

No example specified for this content type

Delete the specified condition

DELETE

http://YOUR_FUNNELFLUX_DOMAIN/admin/api/v2

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

Delete the specified condition

Delete the specified condition › query Parameters

apiKey

string · required

An authorized api key

idCondition

string · required

Delete the specified condition › Responses

Condition deleted successfully

No data returned

Get a list of all conditions as id/name pairs

GET

http://YOUR_FUNNELFLUX_DOMAIN/admin/api/v2

/data/campaign/funnel/condition/list/index.php

Get a list of all conditions as id/name pairs

Get a list of all conditions as id/name pairs › query Parameters

apiKey

string · required

An authorized api key

Get a list of all conditions as id/name pairs › Responses

List of conditions

IdNamePair[]

IdNamePair

id

integer · int64

name

string

Funnel Connections Funnel Code Snippets