Traffic

Operations for traffic

Find All Blocked Offer Sources

GET /v1/affiliates/trafficblocking

This endpoint allows you to retrieve a list of all offer/sub combinations that are blocked.

Returns an empty array if no combination exist.

Filters

This endpoint supports basic filtering. Refer to API filters page for usage.

Value Description
network_offer_id Filter based on the offer id
traffic_blocking_status Filter based on the traffic blocking status
time_created Filter based on the creation time
time_saved Filter based on the last update time

cURL
curl --request GET 'https://api.eflow.team/v1/affiliates/trafficblocking' \
--header 'X-Eflow-API-Key: <INSERT API KEY>' \
--header 'content-type: application/json'
Response
 {
  "traffic_blocking": [
    {
      "network_offer_id": 0,
      "relationship": {
        "variables": {
          "total": 0,
          "entries": [
            {
              "comparison_method": "begins_with",
              "variable": "",
              "variable_value": ""
            }
          ]
        }
      }
    }
  ]
}

Find All Traffic Controls

GET /v1/affiliates/trafficcontrols

This endpoint allows you to retrieve a list of all the traffic controls that are affecting your offers.

To retrieve the values, use the endpoint with the specific traffic control Id.

Returns an empty array if no traffic control exist.

cURL
curl --request GET 'https://api.eflow.team/v1/affiliates/trafficcontrols' \
--header 'X-Eflow-API-Key: <INSERT API KEY>' \
--header 'content-type: application/json'
Response
{
    "traffic_controls": [
        {
            "network_traffic_control_id": 1,
            "status": "active",
            "is_apply_all_offers": true,
            "control_type": "blacklist",
            "date_valid_from": "",
            "date_valid_to": "",
            "comparison_method": "contains",
            "variables": [],
            "relationship": {}
        }
    ]
}

Find Traffic Control By ID

GET /v1/affiliates/trafficcontrols/:controlId

This endpoint allows you to retrieve a traffic control, by Id, that is affecting your offers.

Returns HTTP code 404 if the traffic control doesn’t exist.

Path Parameters

Parameter Description
controlId The ID of the traffic control you want to fetch

cURL
curl --request GET 'https://api.eflow.team/v1/affiliates/trafficcontrols/<INSERT CONTROL ID>' \
--header 'X-Eflow-API-Key: <INSERT API KEY>' \
--header 'content-type: application/json'
Response
{
    "traffic_controls": [
        {
            "network_traffic_control_id": 1,
            "status": "active",
            "is_apply_all_offers": true,
            "control_type": "blacklist",
            "date_valid_from": "",
            "date_valid_to": "",
            "comparison_method": "contains",
            "variables": [],
            "relationship": {}
        }
    ]
}

Find All Blocked Variables

POST /v1/affiliates/blockedvariables

This endpoint list all the variables that are blocking the traffic.

This endpoint includes the values that are blocked at the moment and the ones that were blocked during the selected time interval.

network_offer_id int

The offer with block variables.

timezone_id int

Refer to Meta/Timezones for supported timezones.

from string

YYYY-MM-DD or YYYY-MM-DD HH:mm:SS.

to string

YYYY-MM-DD or YYYY-MM-DD HH:mm:SS.

{
  "from": "",
  "to": "",
  "timezone_id": 90,
  "network_offer_id": 1
}

cURL
curl --request POST \
  --url 'https://api.eflow.team/v1/affiliates/blockedvariables' \
  --header 'x-eflow-api-key: <INSERT API KEY>' \
  --header 'content-type: application/json' \
  --data '<INSERT PAYLOAD>'
Response
{
    "variables": [
        {
            "variable": "source_id",
            "value": "test",
            "operator": "contains"
        }
    ]
}