Sign in

v1

latestOpenAPI 3.0.32026-07-2226694862.5 KB
Traffic Controls

Get Traffic Control

Retrieve a single traffic control by its ID.

get/networks/trafficcontrols/{controlId}

Path parameters

controlIdinteger required

The unique traffic control ID.

Response

network_traffic_control_idinteger

Unique traffic control ID.

network_idinteger

Network ID.

namestring

Name of the traffic control.

status'active' | 'inactive'

Status of the traffic control.

control_type'blacklist' | 'whitelist'

Traffic controls can be either whitelist or blacklist.

targeting_action'block' | 'fail_traffic'

The targeting action.

is_apply_all_offersboolean

Whether this control applies to all offers.

is_apply_all_affiliatesboolean

Whether this control applies to all affiliates.

comparison_method'exact_match' | 'contains' | 'begins_with' | 'ends_with' | 'does_not_contain' | 'does_not_match' | 'is_empty'

Defines how the variables are compared.

variablesstring[]

The click variable that will be looked up and compared to the values supplied. Can be one or multiple values among: sub1, sub2, sub3, sub4, sub5, sub6, sub7, sub8, sub9, sub10, source_id, referrer, isp, ip, user_agent, country, tracking_domain. Note: variables and values are only populated by the Get by ID endpoint.

date_valid_fromstring

Start date for the control's validity period (YYYY-MM-DD).

date_valid_tostring

End date for the control's validity period (YYYY-MM-DD).

time_createdinteger

Unix timestamp of creation.

time_savedinteger

Unix timestamp of last update.

Example response

{
  "time_created": 1734455015,
  "time_saved": 1734455015
}