PopAds API v2 (2.2.1)

PopAds API v2 is designed to facilitate the creation and updating of campaigns and feeds. The API offers a variety of endpoints to retrieve options for campaigns and feeds.

Base URL for all API actions: https://www.popads.net/apiv2

The number of required arguments varies depending on the specific action.

Important: All requests require an API key parameter. This is an individually assigned access token that can be obtained from the Account Manager section of our Panel.

campaign

Endpoints for creating new campaigns and updating existing ones. These allow advertisers to set up and modify their advertising campaigns with various targeting options and parameters.

Retrieve campaign details

Information about campaign

Authorizations:

ApiAccessToken

path Parameters

campaignId

required

integer <int64>

campaign id

Responses

Response samples

200
403
404
500

Content type

application/json

Example

Example response body for multiple urls campaign update

{"status": "success",
"code": 200,
"records": 1,
"messages": ["Your campaign has been updated"
],
"data": null,
"campaign": {"id": 8594963,
"status": "Pending Approval",
"general_information": {"ad_block": "all",
"ad_type": "popunder",
"ad_type_other": false,
"adult": false,
"after_approval": 1,
"frequency_cap": {"days": 5,
"hours": 13,
"minutes": 50
},
"incognito": "regular",
"minimum_quality": 2,
"minimum_quality_mode": "exact",
"name": "Example update campaign with multiple urls",
"primespot": "all",
"referrer": 1,
"urls": ["https://www.myurl6.com/test",
"https://www.myurl7.com/test",
"https://www.myurl8.com/test"
]
},
"budget": {"mode": "smart_bid",
"max_bid": "0.01",
"max_per_day": 2.5,
"budget": 3
},
"throttling": {"type": "auto",
"value": 1.23,
"mode": "spent",
"unit": "s"
},
"categories": {"include_subcategories": false,
"list": [1,
2,
3,
4
]
},
"countries": {"codes": ["GR",
"RU"
],
"regions": ["GR01",
"GR02",
"RU"
]
},
"society": {"language_mode": "first",
"languages": ["af",
"ar-sa"
],
"populations": [0,
3
]
},
"environment": {"os": [1,
14
],
"browser": [2,
174
],
"resolutions": [4,
5,
6,
7
]
},
"device": {"device": [235
],
"form_factor": [ ]
},
"connections": {"conntype": [1,
2,
3,
7
],
"connspeed": [1,
2,
3
],
"internet_service_providers": [2543477
]
},
"time": {"time": ["505",
"602"
],
"timezone": "Europe/Moscow"
},
"website_targeting": {"type": "exclude",
"items_excl": [2832627,
3134369
]
},
"adscore": {"valid_traffic": 1,
"proxy_traffic": 1,
"junk_traffic": 0,
"bot_traffic": 0,
"compliance_intelligence": 1,
"compliance": 1,
"true_location": 0
}
}
}

Create a new Campaign

Authorizations:

ApiAccessToken

Request Body schema: application/json
required

required

object (CampaignGeneralInformationCreate)

name

required

string [ 1 .. 100 ] characters

Choose a name for your campaign, for example: PopAds.

urls

required

Array of strings <uri> [ 1 .. 300 ] items [ items <uri > ]

Choose your landing page(s) url(s), for example http://www.popads.net. Do not forget about http:// or https:// in front of the url.

prefetch_url

string <uri>

Specify URL to be prefetched, if different than campaign URL (for example, if campaign URL is pointing to a tracker). Only when one url in urls field is provided.

minimum_quality

required

integer <int32> [ 1 .. 10 ]

Please choose carefully the quality of the websites you would like to advertise on. If you choose the minimal website quality too high, you will get less traffic and it will be more expensive.Retrieve values from GET Quality

minimum_quality_mode

required

string

Enum: "minimum" "exact"

Retrieve values from GET Quality mode

required

object

Choose how often should one person see your landing page

days required	integer <int32> [ 0 .. 31 ] Retrieve values from GET Frequency cap days
hours required	integer <int32> [ 0 .. 23 ] Retrieve values from GET Frequency cap hours
minutes required	integer <int32> Enum: 0 5 10 15 20 25 30 35 40 45 50 55 Retrieve values from GET Frequency cap minutes

after_approval

required

integer

Enum: 1 3

Choose if campaign has to be started after approval or top up.GET After Approve

adult

required

boolean

Specifies, if the landing page contains adult content.

primespot

required

string

Enum: "all" "primespot" "no_primespot"

PrimeSpot bidding occurs when visitor hasn't received a popunder for last hour.PrimeSpot bidding occurs when visitor hasn't received a popunder for last hour. Retrieve values from GET Prime spot

referrer

required

integer [ 0 .. 2 ]

When set to Blank, campaign will be loaded without referrer URL. Retrieve values from GET Referrer

ad_block

required

string

Enum: "all" "adblock" "no_adblock"

Specifies, whether to include visitors with Adblock enabled or no Adblock. Retrieve values from GET Ad block

incognito

required

string

Enum: "all" "incognito" "no_incognito"

Choose if campaign should be shown in incognito mode. Retrieve values from GET Incognito

ad_type

required

string

Specifies, in what manner your campaign should be presented to visitors. Retrieve values from GET Advertise type

popup

ad_type_other

required

boolean

Allow other methods when the chosen one is not available

required

object (Budget)

mode required	string Type of Budget smart_bid
max_bid required	number <float> >= 0.0005 Specify the maximal price of a single popunder you are willing to accept. Too low bid will result in slower and lower quality traffic. For example, if you do not want to pay more than $5.00 for 1000 popunders, enter 0.005 here.
max_per_day required	number <float> >= 2.5 Choose the daily budget for this campaign. Leave empty to disable this limitation
daily_traffic_shaping	string Enum: "adaptive" "hourly" "Adaptive" distributes remaining daily budget over remaining hours of activity, "Hourly" distributes total daily budget across the number of active hours of activity. Applicable only when daily budget is set.
budget required	number <float> Choose total budget for this campaign. The entered amount of money will be taken from your balance. You can top-up your campaign later. Cannot be used with "global_budget": true.
global_budget	boolean Allows to create campaigns using account's balance instead of local budgets. You can not combine it with budget field.

required

object (Throttling)

type

required

string

You can select throttling mode:

none - our system will deliver your impressions without any speed limits.
manual (legacy) - you can manually reduce traffic speed by chosen percentage.
auto - you can set maximal number of impressions or amount of spending per time unit.

auto

mode

required

string

Enum: "imps" "spent"

Specifies, in what manner throttling thresholds should be calculated Traffic speed (impressions per second) or Spending (USD per second). You can choose either impressions per second (imps) or spending per second (spent) mode.

unit

required

string

Enum: "s" "m" "h"

Choose your campaign spending/speed unit seconds (s), minutes (m), hours (h)

value

required

number <float>

the value must be according to the table :

mode	type	minimum	maximum
imps	s	0.5	10000
imps	m	30	600000
imps	h	1800	36000000
spent	s	0.001	1000
spent	m	0.06	60000
spent	h	3.6	3600000

required

object (Categories)

list required	Array of numbers <int32> (list) [ items <int32 > ] retrieve values from GET categories or leave empty to retrieve all categories
include_subcategories required	boolean (include_subcategories)

required

object (Countries)

codes required	Array of strings retrieve values from GET countries or leave empty to retrieve all countries
regions required	Array of strings In order to enable region targeting, you have to select up to three countries above retrieve values from GET regions or leave empty to retrieve all regions If only regions assigned for one of the countries then add the rest country codes as a regions

required

object (Society)

language_mode required	string (language_mode) Enum: "any" "first" "exact" retrieve values from GET language modes any - You will get traffic from visitors whose browser provides any of the languages you are targeting. first - You will get traffic from visitors whose first (primary) language matches your language targeting. exact - You will get traffic from only visitors whose provided languages all match your language targeting.
languages required	Array of strings (languages) retrieve ids from GET languages or leave empty to retrieve all languages
populations required	Array of numbers <int32> (populations) [ items <int32 > ] retrieve ids from GET populations or leave empty to retrieve all populations

required

object (Environment)

os required	Array of numbers <int32> [ items <int32 > ] retrieve ids from GET os or leave empty to retrieve all operating systems
browser required	Array of numbers <int32> [ items <int32 > ] retrieve ids from GET browser or leave empty to retrieve all browsers
resolutions required	Array of numbers <int32> [ items <int32 > ] retrieve ids from GET resolutions or leave empty to retrieve all resolutions

required

object (Device)

device required	Array of numbers <int32> [ items <int32 > ] retrieve ids from GET device or leave empty to retrieve all devices
form_factor required	Array of numbers <int32> [ items <int32 > ] retrieve ids from GET form_factor or leave empty to retrieve all form factors
request_as_desktop	number <int32> Enum: 0 1 Both Android and iOS mobile browsers offer a "Request as Desktop" feature that makes the mobile browser render pages as if on a notebook/desktop device. That feature also fakes the browser identification, so it no longer identifies as a mobile device. We can detect that and correctly identify what the device really is.

required

object (Connection)

ip_targeting_id	integer <int32> Choose one of the predefined IP Targeting List. When is set, all other targeting options are ignored.
conntype required	Array of numbers <int32> [ items <int32 > ] retrieve ids from GET conntype or leave empty to retrieve all connection types
connspeed required	Array of numbers <int32> [ items <int32 > ] retrieve ids from GET connspeed or leave empty to retrieve all connection speeds
internet_service_providers required	Array of numbers <int32> [ items <int32 > ] retrieve ids from GET internet_service_providers or leave empty to retrieve all internet service providers In order to enable ISP targeting, you have to select up to three countries in Countries object codes.

required

object (Time)

timezone required	string (timezone) retrieve ids from GET timezone Select the timezone you would like the the start and end times be in.
time required	Array of strings (time) retrieve ids from GET time Select the time you would like the the start and end times be in.

required

object (WebsiteTargeting)

items_incl required	Array of numbers <int32> (items_incl) [ items <int32 > ]
type required	string include - You can specify a list of websites you want to target. exclude - you will get traffic from all websites in our network matching your targeting options excluding the websites you added. none - You will get traffic from all websites in our network matching your targeting options. include

required

object (AdScore)

valid_traffic required	number <int32> (valid_traffic) Enum: 0 1 Valid Traffic represents visitors that we consider to be real humans, using residential connections that have the ability to see your landing page. This is the traffic type that is advised for all our advertisers.
proxy_traffic required	number <int32> (proxy_traffic) Enum: 0 1 Proxy Traffic represent visitors that we consider to be real humans, however they employ technology to spoof their geolocation, like Proxies, VPN, Hola etc. Depending on your campaign needs, you may want to buy such traffic (it will be cheaper than Valid Traffic).
junk_traffic required	number <int32> (junk_traffic) Enum: 0 1 Junk Traffic represents visitors that we consider to be real humans, however they use very low performance hardware or highly outdated software. Depending on your campaign needs, you may want to buy such traffic (it will be cheaper than Valid Traffic).
bot_traffic required	number <int32> (bot_traffic) Value: 0 Bot Traffic represents visitors that we believe might not be real humans, or people that modified their browser to fake its User Agent. We do not resell such traffic.
compliance_intelligence required	number <int32> (compliance_intelligence) Value: 1 Enforcing compliance will ensure that you are not buying traffic from any websites that are blacklisted by: Operation Creative IWL WIPO ALERT Project Arachnid
compliance required	number <int32> (compliance) Value: 1 Automatically blocks traffic from websites containing potentially illegal content like high risk torrent websites, child abuse or terrorism related content.

Responses

Request samples

Payload

Content type

application/json

Example

Example request body for campaign creation with multiple urls

{"general_information": {"name": "Example request body for campaign creation with multiple urls",
"urls": ["https://www.myurl1.com/test",
"https://www.myurl2.com/test",
"https://www.myurl3.com/test"
],
"adult": true,
"minimum_quality": 1,
"minimum_quality_mode": "minimum",
"incognito": "incognito",
"frequency_cap": {"days": 2,
"hours": 23,
"minutes": 25
},
"after_approval": 3,
"referrer": 1,
"primespot": "no_primespot",
"ad_type": "popup",
"ad_block": "adblock",
"ad_type_other": true
},
"budget": {"mode": "legacy_bid",
"max_bid": 0.09866406,
"daily_traffic_shaping": "adaptive",
"max_per_day": 5,
"budget": 3
},
"throttling": {"type": "manual",
"speed": 50
},
"categories": {"list": [1,
2
],
"include_subcategories": true
},
"countries": {"codes": ["GR",
"RU",
"DK"
],
"regions": [ ]
},
"society": {"language_mode": "first",
"languages": ["af",
"sq",
"ar-sa"
],
"populations": [1,
5
]
},
"environment": {"os": [5579
],
"browser": [23248
],
"resolutions": [6
]
},
"device": {"device": [237
],
"form_factor": [3155
]
},
"connections": {"ip_targeting_id": 74150
},
"time": {"time": ["110",
"111",
"112",
"113"
],
"timezone": "Europe/Athens"
},
"website_targeting": {"type": "include",
"items_incl": [1883,
1884
]
},
"adscore": {"valid_traffic": 1,
"proxy_traffic": 0,
"junk_traffic": 1,
"bot_traffic": 0,
"compliance_intelligence": 1,
"compliance": 1,
"true_location": 0
}
}

Response samples

201
400
500

Content type

application/json

Example

Example response body for multiple urls campaign creation

{"status": "success",
"code": 201,
"records": 1,
"messages": ["Thank you for the submission. Our staff has just been notified about your new campaign and it will be reviewed as soon as possible.As you set your campaign budget to be $3.00, the amount of $3.00 was debited from your account balance and moved to this campaign budget."
],
"data": {"campaign": {"id": 8573006,
"status": "Pending Approval",
"general_information": {"ad_block": "adblock",
"ad_type": "popup",
"ad_type_other": true,
"adult": true,
"after_approval": 3,
"frequency_cap": {"days": 2,
"hours": 23,
"minutes": 25
},
"incognito": "incognito",
"minimum_quality": 1,
"minimum_quality_mode": "minimum",
"name": "Example update campaign with multiple urls",
"primespot": "no_primespot",
"referrer": 1,
"urls": ["https://www.myurl1.com/test",
"https://www.myurl2.com/test",
"https://www.myurl3.com/test"
]
},
"budget": {"mode": "legacy_bid",
"max_bid": "0.09866406",
"daily_traffic_shaping": "adaptive",
"max_per_day": 5,
"budget": 3
},
"throttling": {"type": "manual",
"speed": 50
},
"categories": {"include_subcategories": true,
"list": [1,
2,
3,
4,
5,
6,
7,
8
]
},
"countries": {"codes": ["GR",
"RU",
"DK"
],
"regions": [ ]
},
"society": {"language_mode": "first",
"languages": ["af",
"sq",
"ar-sa"
],
"populations": [1,
5
]
},
"environment": {"os": [5579
],
"browser": [23248
],
"resolutions": [6
]
},
"device": {"device": [237
],
"form_factor": [3155
]
},
"connections": {"ip_targeting_id": 74150
},
"time": {"time": ["110",
"111",
"112",
"113"
],
"timezone": "Europe/Athens"
},
"website_targeting": {"type": "include",
"items_incl": [1883,
1884
]
},
"adscore": {"valid_traffic": 1,
"proxy_traffic": 0,
"junk_traffic": 1,
"bot_traffic": 0,
"compliance_intelligence": 1,
"compliance": 1
}
}
}
}

Update Campaign

Authorizations:

ApiAccessToken

path Parameters

campaignId

required

integer <int64>

campaign id

Request Body schema: application/json
required

required

object (CampaignGeneralInformationUpdate)

name

required

string <= 100 characters

Choose a name for your campaign, for example: PopAds.

urls

required

Array of strings <uri> <= 300 items [ items <uri > ]

Choose your landing page(s) url(s), for example http://www.popads.net. Do not forget about http:// or https:// in front of the url.

prefetch_url

string <uri>

Specify URL to be prefetched, if different than campaign URL (for example, if campaign URL is pointing to a tracker). Only when one url in urls field is provided.

minimum_quality

required

integer <int32> [ 1 .. 10 ]

Please choose carefully the quality of the websites you would like to advertise on. If you choose the minimal website quality too high, you will get less traffic and it will be more expensive.Retrieve values from GET Quality

minimum_quality_mode

required

string

Enum: "minimum" "exact"

Retrieve values from GET Quality mode

required

object

Choose how often should one person see your landing page

days required	integer <int32> [ 0 .. 31 ] Retrieve values from GET Frequency cap days
hours required	integer <int32> [ 0 .. 23 ] Retrieve values from GET Frequency cap hours
minutes required	integer <int32> Enum: 0 5 10 15 20 25 30 35 40 45 50 55 Retrieve values from GET Frequency cap minutes

after_approval

required

integer

Enum: 1 3

Choose if campaign has to be started after approval or top up.GET After Approve

primespot

required

string

Enum: "all" "primespot" "no_primespot"

PrimeSpot bidding occurs when visitor hasn't received a popunder for last hour.PrimeSpot bidding occurs when visitor hasn't received a popunder for last hour. Retrieve values from GET Prime spot

referrer

required

integer [ 0 .. 2 ]

When set to Blank, campaign will be loaded without referrer URL. Retrieve values from GET Referrer

ad_block

required

string

Enum: "all" "adblock" "no_adblock"

Specifies, whether to include visitors with Adblock enabled or no Adblock. Retrieve values from GET Ad block

incognito

required

string

Enum: "all" "incognito" "no_incognito"

Choose if campaign should be shown in incognito mode. Retrieve values from GET Incognito

ad_type

required

string

Specifies, in what manner your campaign should be presented to visitors. Retrieve values from GET Advertise type

popup

ad_type_other

required

boolean

Allow other methods when the chosen one is not available

required

object (Budget-2)

mode required	string Type of Budget smart_bid
max_bid required	number <float> >= 0.0005 Specify the maximal price of a single popunder you are willing to accept. Too low bid will result in slower and lower quality traffic. For example, if you do not want to pay more than $5.00 for 1000 popunders, enter 0.005 here.
max_per_day required	number <float> >= 2.5 Choose the daily budget for this campaign. Leave empty to disable this limitation
daily_traffic_shaping	string Enum: "adaptive" "hourly" "Adaptive" distributes remaining daily budget over remaining hours of activity, "Hourly" distributes total daily budget across the number of active hours of activity. Applicable only when daily budget is set.
global_budget	boolean Allows to create campaigns using account's balance instead of local budgets. You can not combine it with budget field.

required

object (Throttling)

type

required

string

You can select throttling mode:

none - our system will deliver your impressions without any speed limits.
manual (legacy) - you can manually reduce traffic speed by chosen percentage.
auto - you can set maximal number of impressions or amount of spending per time unit.

auto

mode

required

string

Enum: "imps" "spent"

Specifies, in what manner throttling thresholds should be calculated Traffic speed (impressions per second) or Spending (USD per second). You can choose either impressions per second (imps) or spending per second (spent) mode.

unit

required

string

Enum: "s" "m" "h"

Choose your campaign spending/speed unit seconds (s), minutes (m), hours (h)

value

required

number <float>

the value must be according to the table :

mode	type	minimum	maximum
imps	s	0.5	10000
imps	m	30	600000
imps	h	1800	36000000
spent	s	0.001	1000
spent	m	0.06	60000
spent	h	3.6	3600000

required

object (Categories)

list required	Array of numbers <int32> (list) [ items <int32 > ] retrieve values from GET categories or leave empty to retrieve all categories
include_subcategories required	boolean (include_subcategories)

required

object (Countries)

codes required	Array of strings retrieve values from GET countries or leave empty to retrieve all countries
regions required	Array of strings In order to enable region targeting, you have to select up to three countries above retrieve values from GET regions or leave empty to retrieve all regions If only regions assigned for one of the countries then add the rest country codes as a regions

required

object (Society)

language_mode required	string (language_mode) Enum: "any" "first" "exact" retrieve values from GET language modes any - You will get traffic from visitors whose browser provides any of the languages you are targeting. first - You will get traffic from visitors whose first (primary) language matches your language targeting. exact - You will get traffic from only visitors whose provided languages all match your language targeting.
languages required	Array of strings (languages) retrieve ids from GET languages or leave empty to retrieve all languages
populations required	Array of numbers <int32> (populations) [ items <int32 > ] retrieve ids from GET populations or leave empty to retrieve all populations

required

object (Environment)

os required	Array of numbers <int32> [ items <int32 > ] retrieve ids from GET os or leave empty to retrieve all operating systems
browser required	Array of numbers <int32> [ items <int32 > ] retrieve ids from GET browser or leave empty to retrieve all browsers
resolutions required	Array of numbers <int32> [ items <int32 > ] retrieve ids from GET resolutions or leave empty to retrieve all resolutions

required

object (Device)

device required	Array of numbers <int32> [ items <int32 > ] retrieve ids from GET device or leave empty to retrieve all devices
form_factor required	Array of numbers <int32> [ items <int32 > ] retrieve ids from GET form_factor or leave empty to retrieve all form factors
request_as_desktop	number <int32> Enum: 0 1 Both Android and iOS mobile browsers offer a "Request as Desktop" feature that makes the mobile browser render pages as if on a notebook/desktop device. That feature also fakes the browser identification, so it no longer identifies as a mobile device. We can detect that and correctly identify what the device really is.

required

object (Connection)

ip_targeting_id	integer <int32> Choose one of the predefined IP Targeting List. When is set, all other targeting options are ignored.
conntype required	Array of numbers <int32> [ items <int32 > ] retrieve ids from GET conntype or leave empty to retrieve all connection types
connspeed required	Array of numbers <int32> [ items <int32 > ] retrieve ids from GET connspeed or leave empty to retrieve all connection speeds
internet_service_providers required	Array of numbers <int32> [ items <int32 > ] retrieve ids from GET internet_service_providers or leave empty to retrieve all internet service providers In order to enable ISP targeting, you have to select up to three countries in Countries object codes.

required

object (Time)

timezone required	string (timezone) retrieve ids from GET timezone Select the timezone you would like the the start and end times be in.
time required	Array of strings (time) retrieve ids from GET time Select the time you would like the the start and end times be in.

required

object (WebsiteTargeting)

items_incl required	Array of numbers <int32> (items_incl) [ items <int32 > ]
type required	string include - You can specify a list of websites you want to target. exclude - you will get traffic from all websites in our network matching your targeting options excluding the websites you added. none - You will get traffic from all websites in our network matching your targeting options. include

required

object (AdScore)

valid_traffic required	number <int32> (valid_traffic) Enum: 0 1 Valid Traffic represents visitors that we consider to be real humans, using residential connections that have the ability to see your landing page. This is the traffic type that is advised for all our advertisers.
proxy_traffic required	number <int32> (proxy_traffic) Enum: 0 1 Proxy Traffic represent visitors that we consider to be real humans, however they employ technology to spoof their geolocation, like Proxies, VPN, Hola etc. Depending on your campaign needs, you may want to buy such traffic (it will be cheaper than Valid Traffic).
junk_traffic required	number <int32> (junk_traffic) Enum: 0 1 Junk Traffic represents visitors that we consider to be real humans, however they use very low performance hardware or highly outdated software. Depending on your campaign needs, you may want to buy such traffic (it will be cheaper than Valid Traffic).
bot_traffic required	number <int32> (bot_traffic) Value: 0 Bot Traffic represents visitors that we believe might not be real humans, or people that modified their browser to fake its User Agent. We do not resell such traffic.
compliance_intelligence required	number <int32> (compliance_intelligence) Value: 1 Enforcing compliance will ensure that you are not buying traffic from any websites that are blacklisted by: Operation Creative IWL WIPO ALERT Project Arachnid
compliance required	number <int32> (compliance) Value: 1 Automatically blocks traffic from websites containing potentially illegal content like high risk torrent websites, child abuse or terrorism related content.

Responses

Request samples

Payload

Content type

application/json

Example

Example request body for campaign update with multiple urls

{"general_information": {"name": "Example update campaign with multiple urls",
"urls": ["https://www.myurl6.com/test",
"https://www.myurl7.com/test",
"https://www.myurl8.com/test"
],
"minimum_quality": 2,
"minimum_quality_mode": "exact",
"frequency_cap": {"days": 5,
"hours": 13,
"minutes": 50
},
"incognito": "regular",
"after_approval": 1,
"referrer": 1,
"primespot": "all",
"ad_type": "popunder",
"ad_block": "all",
"ad_type_other": false
},
"budget": {"mode": "smart_bid",
"max_bid": 0.01,
"max_per_day": 2.5
},
"throttling": {"type": "auto",
"unit": "s",
"mode": "spent",
"value": 1.23
},
"categories": {"list": [1,
2,
3,
4
],
"include_subcategories": false
},
"society": {"language_mode": "first",
"languages": ["af",
"ar-sa"
],
"populations": [0,
3
]
},
"environment": {"os": [1,
14
],
"browser": [2,
174
],
"resolutions": [4,
5,
6,
7
]
},
"device": {"device": [235,
237
],
"form_factor": [ ]
},
"countries": {"codes": ["GR",
"RU"
],
"regions": ["GR",
"GR02",
"RU"
]
},
"connections": {"conntype": [1,
2,
3,
7
],
"connspeed": [1,
2,
3
],
"internet_service_providers": [2543477
]
},
"time": {"timezone": "Europe/Moscow",
"time": [505,
602
]
},
"website_targeting": {"type": "exclude",
"items_excl": [2832627,
3134369
]
},
"adscore": {"valid_traffic": 1,
"proxy_traffic": 1,
"junk_traffic": 0,
"bot_traffic": 0,
"compliance_intelligence": 1,
"compliance": 1
}
}

Response samples

200
400
404
500

Content type

application/json

Example

Example response body for multiple urls campaign update

{"status": "success",
"code": 200,
"records": 1,
"messages": ["Your campaign has been updated"
],
"data": null,
"campaign": {"id": 8594963,
"status": "Pending Approval",
"general_information": {"ad_block": "all",
"ad_type": "popunder",
"ad_type_other": false,
"adult": false,
"after_approval": 1,
"frequency_cap": {"days": 5,
"hours": 13,
"minutes": 50
},
"incognito": "regular",
"minimum_quality": 2,
"minimum_quality_mode": "exact",
"name": "Example update campaign with multiple urls",
"primespot": "all",
"referrer": 1,
"urls": ["https://www.myurl6.com/test",
"https://www.myurl7.com/test",
"https://www.myurl8.com/test"
]
},
"budget": {"mode": "smart_bid",
"max_bid": "0.01",
"max_per_day": 2.5,
"budget": 3
},
"throttling": {"type": "auto",
"value": 1.23,
"mode": "spent",
"unit": "s"
},
"categories": {"include_subcategories": false,
"list": [1,
2,
3,
4
]
},
"countries": {"codes": ["GR",
"RU"
],
"regions": ["GR01",
"GR02",
"RU"
]
},
"society": {"language_mode": "first",
"languages": ["af",
"ar-sa"
],
"populations": [0,
3
]
},
"environment": {"os": [1,
14
],
"browser": [2,
174
],
"resolutions": [4,
5,
6,
7
]
},
"device": {"device": [235
],
"form_factor": [ ]
},
"connections": {"conntype": [1,
2,
3,
7
],
"connspeed": [1,
2,
3
],
"internet_service_providers": [2543477
]
},
"time": {"time": ["505",
"602"
],
"timezone": "Europe/Moscow"
},
"website_targeting": {"type": "exclude",
"items_excl": [2832627,
3134369
]
},
"adscore": {"valid_traffic": 1,
"proxy_traffic": 1,
"junk_traffic": 0,
"bot_traffic": 0,
"compliance_intelligence": 1,
"compliance": 1,
"true_location": 0
}
}
}

Patch Campaign

Authorizations:

ApiAccessToken

path Parameters

campaignId

required

integer <int64>

campaign id

Request Body schema: application/json
required

object (CampaignGeneralInformationPatchUpdate)

name

string <= 100 characters

Choose a name for your campaign, for example: PopAds.

urls

Array of strings <uri> <= 300 items [ items <uri > ]

Choose your landing page(s) url(s), for example http://www.popads.net. Do not forget about http:// or https:// in front of the url.

prefetch_url

string <uri>

Specify URL to be prefetched, if different than campaign URL (for example, if campaign URL is pointing to a tracker). Only when one url in urls field is provided.

minimum_quality

integer <int32> [ 1 .. 10 ]

Please choose carefully the quality of the websites you would like to advertise on. If you choose the minimal website quality too high, you will get less traffic and it will be more expensive.Retrieve values from GET Quality

minimum_quality_mode

string

Enum: "minimum" "exact"

Retrieve values from GET Quality mode

object

Choose how often should one person see your landing page

days	integer <int32> [ 0 .. 31 ] Retrieve values from GET Frequency cap days
hours	integer <int32> [ 0 .. 23 ] Retrieve values from GET Frequency cap hours
minutes	integer <int32> Enum: 0 5 10 15 20 25 30 35 40 45 50 55 Retrieve values from GET Frequency cap minutes

after_approval

integer

Enum: 1 3

Choose if campaign has to be started after approval or top up.GET After Approve

primespot

string

Enum: "all" "primespot" "no_primespot"

PrimeSpot bidding occurs when visitor hasn't received a popunder for last hour.PrimeSpot bidding occurs when visitor hasn't received a popunder for last hour. Retrieve values from GET Prime spot

referrer

integer [ 0 .. 2 ]

When set to Blank, campaign will be loaded without referrer URL. Retrieve values from GET Referrer

ad_block

string

Enum: "all" "adblock" "no_adblock"

Specifies, whether to include visitors with Adblock enabled or no Adblock. Retrieve values from GET Ad block

incognito

string

Enum: "all" "incognito" "no_incognito"

Choose if campaign should be shown in incognito mode. Retrieve values from GET Incognito

ad_type

string

Specifies, in what manner your campaign should be presented to visitors. Retrieve values from GET Advertise type

popup

ad_type_other

boolean

Allow other methods when the chosen one is not available

object (Budget-3)

mode	string Type of Budget smart_bid
max_bid	number <float> >= 0.0005 Specify the maximal price of a single popunder you are willing to accept. Too low bid will result in slower and lower quality traffic. For example, if you do not want to pay more than $5.00 for 1000 popunders, enter 0.005 here.
max_per_day	number <float> >= 2.5 Choose the daily budget for this campaign. Leave empty to disable this limitation
global_budget	boolean Allows to create campaigns using account's balance instead of local budgets.

object (Throttling-2)

type

string

You can select throttling mode:

none - our system will deliver your impressions without any speed limits.
manual (legacy) - you can manually reduce traffic speed by chosen percentage.
auto - you can set maximal number of impressions or amount of spending per time unit.

auto

mode

string

Enum: "imps" "spent"

Specifies, in what manner throttling thresholds should be calculated Traffic speed (impressions per second) or Spending (USD per second). You can choose either impressions per second (imps) or spending per second (spent) mode.

unit

string

Enum: "s" "m" "h"

Choose your campaign spending/speed unit seconds (s), minutes (m), hours (h)

value

number <float>

the value must be according to the table :

mode	type	minimum	maximum
imps	s	0.5	10000
imps	m	30	600000
imps	h	1800	36000000
spent	s	0.001	1000
spent	m	0.06	60000
spent	h	3.6	3600000

object (Categories-2)

list	Array of numbers <int32> [ items <int32 > ] retrieve values from GET categories or leave empty to retrieve all categories
include_subcategories	boolean

object (Countries-2)

codes	Array of strings retrieve values from GET countries or leave empty to retrieve all countries
regions	Array of strings In order to enable region targeting, you have to select up to three countries above retrieve values from GET regions or leave empty to retrieve all regions If only regions assigned for one of the countries then add the rest country codes as a regions

object (Society-2)

language_mode	string Enum: "any" "first" "exact" retrieve values from GET language modes any - You will get traffic from visitors whose browser provides any of the languages you are targeting. first - You will get traffic from visitors whose first (primary) language matches your language targeting. exact - You will get traffic from only visitors whose provided languages all match your language targeting.
languages	Array of strings retrieve ids from GET languages or leave empty to retrieve all languages
populations	Array of numbers <int32> [ items <int32 > ] retrieve ids from GET populations or leave empty to retrieve all populations

object (Environment-2)

os	Array of numbers <int32> [ items <int32 > ] retrieve ids from GET os or leave empty to retrieve all operating systems
browser	Array of numbers <int32> [ items <int32 > ] retrieve ids from GET browser or leave empty to retrieve all browsers
resolutions	Array of numbers <int32> [ items <int32 > ] retrieve ids from GET resolutions or leave empty to retrieve all resolutions

object (Device-2)

device	Array of numbers <int32> [ items <int32 > ] retrieve ids from GET device or leave empty to retrieve all devices
form_factor	Array of numbers <int32> [ items <int32 > ] retrieve ids from GET form_factor or leave empty to retrieve all form factors
request_as_desktop	number <int32> Enum: 0 1 Both Android and iOS mobile browsers offer a "Request as Desktop" feature that makes the mobile browser render pages as if on a notebook/desktop device. That feature also fakes the browser identification, so it no longer identifies as a mobile device. We can detect that and correctly identify what the device really is.

object (Connection-2)

ip_targeting_id	integer <int32> Choose one of the predefined IP Targeting List. When is set, all other targeting options are ignored.
conntype	Array of numbers <int32> [ items <int32 > ] retrieve ids from GET conntype or leave empty to retrieve all connection types
connspeed	Array of numbers <int32> [ items <int32 > ] retrieve ids from GET connspeed or leave empty to retrieve all connection speeds
internet_service_providers	Array of numbers <int32> [ items <int32 > ] retrieve ids from GET internet_service_providers or leave empty to retrieve all internet service providers In order to enable ISP targeting, you have to select up to three countries in Countries object codes.

object (Time-2)

time	Array of strings retrieve ids from GET time Select the time you would like the the start and end times be in.
timezone	string retrieve ids from GET timezone Select the timezone you would like the the start and end times be in.

object (WebsiteTargeting-2)

items_incl	Array of numbers <int32> [ items <int32 > ]
type	string include - You can specify a list of websites you want to target. exclude - you will get traffic from all websites in our network matching your targeting options excluding the websites you added. none - You will get traffic from all websites in our network matching your targeting options. include

object (AdScore-2)

valid_traffic	number <int32> Enum: 0 1 Valid Traffic represents visitors that we consider to be real humans, using residential connections that have the ability to see your landing page. This is the traffic type that is advised for all our advertisers.
proxy_traffic	number <int32> Enum: 0 1 Proxy Traffic represent visitors that we consider to be real humans, however they employ technology to spoof their geolocation, like Proxies, VPN, Hola etc. Depending on your campaign needs, you may want to buy such traffic (it will be cheaper than Valid Traffic).
true_location	number <int32> Enum: 0 1 Try to determine real visitor's country for Proxy Traffic. Assigned only when proxy_traffic = 1 and conntype = 7 (Connection object).
junk_traffic	number <int32> Enum: 0 1 Junk Traffic represents visitors that we consider to be real humans, however they use very low performance hardware or highly outdated software. Depending on your campaign needs, you may want to buy such traffic (it will be cheaper than Valid Traffic).
bot_traffic	number <int32> Value: 0 Bot Traffic represents visitors that we believe might not be real humans, or people that modified their browser to fake its User Agent. We do not resell such traffic.
compliance_intelligence	number <int32> Value: 1 Enforcing compliance will ensure that you are not buying traffic from any websites that are blacklisted by: Operation Creative IWL WIPO ALERT Project Arachnid
compliance	number <int32> Value: 1 Automatically blocks traffic from websites containing potentially illegal content like high risk torrent websites, child abuse or terrorism related content.

Responses

Request samples

Payload

Content type

application/json

Example

Example request body for campaign patch with multiple urls

{"general_information": {"urls": ["https://www.myurl6.com/test",
"https://www.myurl7.com/test",
"https://www.myurl8.com/test"
]
}
}

Response samples

200
404
500

Content type

application/json

Example

Example response body for multiple urls campaign update

{"status": "success",
"code": 200,
"records": 1,
"messages": ["Your campaign has been updated"
],
"data": null,
"campaign": {"id": 8594963,
"status": "Pending Approval",
"general_information": {"ad_block": "all",
"ad_type": "popunder",
"ad_type_other": false,
"adult": false,
"after_approval": 1,
"frequency_cap": {"days": 5,
"hours": 13,
"minutes": 50
},
"incognito": "regular",
"minimum_quality": 2,
"minimum_quality_mode": "exact",
"name": "Example update campaign with multiple urls",
"primespot": "all",
"referrer": 1,
"urls": ["https://www.myurl6.com/test",
"https://www.myurl7.com/test",
"https://www.myurl8.com/test"
]
},
"budget": {"mode": "smart_bid",
"max_bid": "0.01",
"max_per_day": 2.5,
"budget": 3
},
"throttling": {"type": "auto",
"value": 1.23,
"mode": "spent",
"unit": "s"
},
"categories": {"include_subcategories": false,
"list": [1,
2,
3,
4
]
},
"countries": {"codes": ["GR",
"RU"
],
"regions": ["GR01",
"GR02",
"RU"
]
},
"society": {"language_mode": "first",
"languages": ["af",
"ar-sa"
],
"populations": [0,
3
]
},
"environment": {"os": [1,
14
],
"browser": [2,
174
],
"resolutions": [4,
5,
6,
7
]
},
"device": {"device": [235
],
"form_factor": [ ]
},
"connections": {"conntype": [1,
2,
3,
7
],
"connspeed": [1,
2,
3
],
"internet_service_providers": [2543477
]
},
"time": {"time": ["505",
"602"
],
"timezone": "Europe/Moscow"
},
"website_targeting": {"type": "exclude",
"items_excl": [2832627,
3134369
]
},
"adscore": {"valid_traffic": 1,
"proxy_traffic": 1,
"junk_traffic": 0,
"bot_traffic": 0,
"compliance_intelligence": 1,
"compliance": 1,
"true_location": 0
}
}
}

feed

Endpoints for creating and updating feeds. Feeds are used to manage multiple ad placements or websites where ads will be displayed, allowing for efficient bulk management of ad inventory.

Retrieve feed details

Information about feed

Authorizations:

ApiAccessToken

path Parameters

feedId

integer <int64>

feed id

Responses

Response samples

200
403
404
500

Content type

application/json

{"status": "success",
"code": 200,
"records": 1,
"messages": "Your campaign has been updated",
"data": {"id": 12345,
"status": "Paused",
"general_information": {"name": "update floatingbanner feed",
"urls": ["https://www.myurl1.com/test"
],
"minimum_quality": 1,
"minimum_quality_mode": "exact",
"ad_type": "floatingbanner",
"ad_block": "all",
"bid_modifier": 0,
"referrer": 2,
"primespot": "no_primespot",
"position": "top-left",
"floating_url": "https://www.myurl1.com/test2",
"width": "550px",
"height": "250px",
"incognito": "all"
},
"openrtb": {"root_ext": {"sub": "[WEBSITEID]"
},
"user_ext": {"remote_addr": "[IP]",
"x_forwarded_for": "[XFOFO]"
}
},
"throttling": {"type": "none"
},
"categories": {"list": [1,
2,
3
],
"include_subcategories": true
},
"countries": {"codes": ["AM",
"AS",
"AZ"
],
"regions": [ ]
},
"society": {"language_mode": "exact",
"languages": ["af",
"hu"
],
"populations": [4,
8
]
},
"environment": {"os": [91
],
"browser": [194
],
"resolutions": [4,
10
]
},
"device": {"device": [ ],
"form_factor": [ ],
"request_as_desktop": 0
},
"connections": {"ip_targeting_id": 75279
},
"time": {"time": [101,
201,
301
],
"timezone": "Detect"
},
"website_targeting": {"type": "none",
"id": 9603
},
"adscore": {"valid_traffic": 1,
"proxy_traffic": 1,
"junk_traffic": 0,
"bot_traffic": 0,
"compliance_intelligence": 1,
"compliance": 1
}
}
}

Create a new feed

Authorizations:

ApiAccessToken

Request Body schema: application/json
required

required

object (FeedGeneralInformation)

name required	string [ 1 .. 100 ] characters Choose a name for your campaign, for example: PopAds.
urls required	Array of strings <uri> = 1 items [ items <uri > ] Choose your landing page url, for example http://www.popads.net. Do not forget about http:// or https:// in front of the url.
minimum_quality required	integer <int32> [ 1 .. 10 ] Please choose carefully the quality of the websites you would like to advertise on. If you choose the minimal website quality too high, you will get less traffic and it will be more expensive. Retrieve values from GET Quality
minimum_quality_mode required	string Enum: "minimum" "exact" Retrieve values from GET Quality mode
primespot required	string Enum: "all" "primespot" "no_primespot" PrimeSpot bidding occurs when visitor hasn't received a popunder for last hour.PrimeSpot bidding occurs when visitor hasn't received a popunder for last hour. Retrieve values from GET Prime spot
referrer required	integer [ 0 .. 2 ] When set to Blank, campaign will be loaded without referrer URL. Retrieve values from GET categories
ad_block required	string Enum: "all" "adblock" "no_adblock" Specifies, whether to include visitors with Adblock enabled or no Adblock. Retrieve values from GET Ad block
incognito required	string Enum: "all" "incognito" "no_incognito" Choose if campaign should be shown in incognito mode. Retrieve values from GET Incognito
ad_type required	string Specifies, in what manner your campaign should be presented to visitors. Retrieve values from GET Advertise type popup
bid_modifier required	number <int32> [ 0 .. 100 ] Enter a bid modifier in % (for example, "80" means 80% of returned bid)
ad_type_other required	boolean Allow other methods when the chosen one is not available

object (OpenRTB)

Use this section only if your feed is using OpenRTB protocol. For normal XML/JSON feeds, leave all fields on this tab blank.

root_ext	object <json> A valid JSON value containing fields to include under "ext" key in root of JSON payload. Can contain placeholders same as allowed in URL.
imp_ext	object <json> A valid JSON value containing fields to include under "ext" key in the "imp" object of JSON payload. Can contain placeholders same as allowed in URL.
site_ext	object <json> A valid JSON value containing fields to include under "ext" key in the "site" object of JSON payload. Can contain placeholders same as allowed in URL.
device_ext	object <json> A valid JSON value containing fields to include under "ext" key in the "device" object of JSON payload. Can contain placeholders same as allowed in URL.
user_ext	object <json> A valid JSON value containing fields to include under "ext" key in the "user" object of JSON payload. Can contain placeholders same as allowed in URL.

required

object (ThrottlingFeed)

type required	string You can select throttling mode: none - our system will deliver your impressions without any speed limits. manual (legacy) - you can manually reduce traffic speed by chosen percentage. auto - you can set maximal number of impressions or amount of spending per time unit. manual
speed required	number <float> [ 0.1 .. 100 ] Choose your campaign speed

required

object (Categories)

list required	Array of numbers <int32> (list) [ items <int32 > ] retrieve values from GET categories or leave empty to retrieve all categories
include_subcategories required	boolean (include_subcategories)

required

object (Countries)

codes required	Array of strings retrieve values from GET countries or leave empty to retrieve all countries
regions required	Array of strings In order to enable region targeting, you have to select up to three countries above retrieve values from GET regions or leave empty to retrieve all regions If only regions assigned for one of the countries then add the rest country codes as a regions

required

object (Society)

language_mode required	string (language_mode) Enum: "any" "first" "exact" retrieve values from GET language modes any - You will get traffic from visitors whose browser provides any of the languages you are targeting. first - You will get traffic from visitors whose first (primary) language matches your language targeting. exact - You will get traffic from only visitors whose provided languages all match your language targeting.
languages required	Array of strings (languages) retrieve ids from GET languages or leave empty to retrieve all languages
populations required	Array of numbers <int32> (populations) [ items <int32 > ] retrieve ids from GET populations or leave empty to retrieve all populations

required

object (Environment)

os required	Array of numbers <int32> [ items <int32 > ] retrieve ids from GET os or leave empty to retrieve all operating systems
browser required	Array of numbers <int32> [ items <int32 > ] retrieve ids from GET browser or leave empty to retrieve all browsers
resolutions required	Array of numbers <int32> [ items <int32 > ] retrieve ids from GET resolutions or leave empty to retrieve all resolutions

required

object (Device)

device required	Array of numbers <int32> [ items <int32 > ] retrieve ids from GET device or leave empty to retrieve all devices
form_factor required	Array of numbers <int32> [ items <int32 > ] retrieve ids from GET form_factor or leave empty to retrieve all form factors
request_as_desktop	number <int32> Enum: 0 1 Both Android and iOS mobile browsers offer a "Request as Desktop" feature that makes the mobile browser render pages as if on a notebook/desktop device. That feature also fakes the browser identification, so it no longer identifies as a mobile device. We can detect that and correctly identify what the device really is.

required

object (Connection)

ip_targeting_id	integer <int32> Choose one of the predefined IP Targeting List. When is set, all other targeting options are ignored.
conntype required	Array of numbers <int32> [ items <int32 > ] retrieve ids from GET conntype or leave empty to retrieve all connection types
connspeed required	Array of numbers <int32> [ items <int32 > ] retrieve ids from GET connspeed or leave empty to retrieve all connection speeds
internet_service_providers required	Array of numbers <int32> [ items <int32 > ] retrieve ids from GET internet_service_providers or leave empty to retrieve all internet service providers In order to enable ISP targeting, you have to select up to three countries in Countries object codes.

required

object (Time)

timezone required	string (timezone) retrieve ids from GET timezone Select the timezone you would like the the start and end times be in.
time required	Array of strings (time) retrieve ids from GET time Select the time you would like the the start and end times be in.

required

object (WebsiteTargeting)

items_incl required	Array of numbers <int32> (items_incl) [ items <int32 > ]
type required	string include - You can specify a list of websites you want to target. exclude - you will get traffic from all websites in our network matching your targeting options excluding the websites you added. none - You will get traffic from all websites in our network matching your targeting options. include

required

object (AdScore)

valid_traffic required	number <int32> (valid_traffic) Enum: 0 1 Valid Traffic represents visitors that we consider to be real humans, using residential connections that have the ability to see your landing page. This is the traffic type that is advised for all our advertisers.
proxy_traffic required	number <int32> (proxy_traffic) Enum: 0 1 Proxy Traffic represent visitors that we consider to be real humans, however they employ technology to spoof their geolocation, like Proxies, VPN, Hola etc. Depending on your campaign needs, you may want to buy such traffic (it will be cheaper than Valid Traffic).
junk_traffic required	number <int32> (junk_traffic) Enum: 0 1 Junk Traffic represents visitors that we consider to be real humans, however they use very low performance hardware or highly outdated software. Depending on your campaign needs, you may want to buy such traffic (it will be cheaper than Valid Traffic).
bot_traffic required	number <int32> (bot_traffic) Value: 0 Bot Traffic represents visitors that we believe might not be real humans, or people that modified their browser to fake its User Agent. We do not resell such traffic.
compliance_intelligence required	number <int32> (compliance_intelligence) Value: 1 Enforcing compliance will ensure that you are not buying traffic from any websites that are blacklisted by: Operation Creative IWL WIPO ALERT Project Arachnid
compliance required	number <int32> (compliance) Value: 1 Automatically blocks traffic from websites containing potentially illegal content like high risk torrent websites, child abuse or terrorism related content.

Responses

Request samples

Payload

Content type

application/json

Example request body for feed creation for floating banner

{"general_information": {"name": "floatingbanner - throttling none -  website id",
"urls": ["https://www.myrl2.com/example"
],
"minimum_quality": 1,
"minimum_quality_mode": "exact",
"ad_type": "floatingbanner",
"ad_block": "all",
"bid_modifier": 0,
"referrer": 2,
"primespot": "no_primespot",
"position": "top-left",
"floating_url": "https://www.myrul1.com/example",
"width": "550px",
"height": "250px",
"incognito": "all"
},
"openrtb": {"root_ext": {"sub": "[WEBSITEID]"
},
"user_ext": {"remote_addr": "[IP]",
"x_forwarded_for": "[XFOFO]"
}
},
"throttling": {"type": "none"
},
"categories": {"list": [1,
2,
3
],
"include_subcategories": true
},
"countries": {"codes": ["AM",
"AS",
"AZ"
],
"regions": [ ]
},
"society": {"language_mode": "exact",
"languages": ["af",
"hu"
],
"populations": [4,
8
]
},
"environment": {"os": [91
],
"browser": [194
],
"resolutions": [4,
10
]
},
"device": {"device": [ ],
"form_factor": [ ],
"request_as_desktop": 0
},
"connections": {"ip_targeting_id": 75279
},
"time": {"time": [101,
201,
301
],
"timezone": "Detect"
},
"website_targeting": {"type": "none",
"id": 9603
},
"adscore": {"valid_traffic": 1,
"proxy_traffic": 1,
"junk_traffic": 0,
"bot_traffic": 0,
"compliance_intelligence": 1,
"compliance": 1
}
}

Response samples

201
400
500

Content type

application/json

Example response body for feed creation for floating banner

{"status": "success",
"code": 200,
"records": 1,
"data": {"general_information": {"name": "create floatingbanner feed",
"urls": ["https://www.myrl2.com/example"
],
"minimum_quality": 1,
"minimum_quality_mode": "exact",
"ad_type": "floatingbanner",
"ad_block": "all",
"bid_modifier": 0,
"referrer": 2,
"primespot": "no_primespot",
"position": "top-left",
"floating_url": "https://www.myrul1.com/example",
"width": "550px",
"height": "250px",
"incognito": "all"
},
"openrtb": {"root_ext": {"sub": "[WEBSITEID]"
},
"user_ext": {"remote_addr": "[IP]",
"x_forwarded_for": "[XFOFO]"
}
},
"throttling": {"type": "none"
},
"categories": {"list": [1,
2,
3
],
"include_subcategories": true
},
"countries": {"codes": ["AM",
"AS",
"AZ"
],
"regions": [ ]
},
"society": {"language_mode": "exact",
"languages": ["af",
"hu"
],
"populations": [4,
8
]
},
"environment": {"os": [91
],
"browser": [194
],
"resolutions": [4,
10
]
},
"device": {"device": [ ],
"form_factor": [ ],
"request_as_desktop": 0
},
"connections": {"ip_targeting_id": 75279
},
"time": {"time": [101,
201,
301
],
"timezone": "Detect"
},
"website_targeting": {"type": "none",
"id": 9603
},
"adscore": {"valid_traffic": 1,
"proxy_traffic": 1,
"junk_traffic": 0,
"bot_traffic": 0,
"compliance_intelligence": 1,
"compliance": 0
}
}
}

Update Feed

Authorizations:

ApiAccessToken

path Parameters

feedId

integer <int64>

feed id

Request Body schema: application/json
required

required

object (FeedGeneralInformation)

name required	string [ 1 .. 100 ] characters Choose a name for your campaign, for example: PopAds.
urls required	Array of strings <uri> = 1 items [ items <uri > ] Choose your landing page url, for example http://www.popads.net. Do not forget about http:// or https:// in front of the url.
minimum_quality required	integer <int32> [ 1 .. 10 ] Please choose carefully the quality of the websites you would like to advertise on. If you choose the minimal website quality too high, you will get less traffic and it will be more expensive. Retrieve values from GET Quality
minimum_quality_mode required	string Enum: "minimum" "exact" Retrieve values from GET Quality mode
primespot required	string Enum: "all" "primespot" "no_primespot" PrimeSpot bidding occurs when visitor hasn't received a popunder for last hour.PrimeSpot bidding occurs when visitor hasn't received a popunder for last hour. Retrieve values from GET Prime spot
referrer required	integer [ 0 .. 2 ] When set to Blank, campaign will be loaded without referrer URL. Retrieve values from GET categories
ad_block required	string Enum: "all" "adblock" "no_adblock" Specifies, whether to include visitors with Adblock enabled or no Adblock. Retrieve values from GET Ad block
incognito required	string Enum: "all" "incognito" "no_incognito" Choose if campaign should be shown in incognito mode. Retrieve values from GET Incognito
ad_type required	string Specifies, in what manner your campaign should be presented to visitors. Retrieve values from GET Advertise type popup
bid_modifier required	number <int32> [ 0 .. 100 ] Enter a bid modifier in % (for example, "80" means 80% of returned bid)
ad_type_other required	boolean Allow other methods when the chosen one is not available

object (OpenRTB)

Use this section only if your feed is using OpenRTB protocol. For normal XML/JSON feeds, leave all fields on this tab blank.

root_ext	object <json> A valid JSON value containing fields to include under "ext" key in root of JSON payload. Can contain placeholders same as allowed in URL.
imp_ext	object <json> A valid JSON value containing fields to include under "ext" key in the "imp" object of JSON payload. Can contain placeholders same as allowed in URL.
site_ext	object <json> A valid JSON value containing fields to include under "ext" key in the "site" object of JSON payload. Can contain placeholders same as allowed in URL.
device_ext	object <json> A valid JSON value containing fields to include under "ext" key in the "device" object of JSON payload. Can contain placeholders same as allowed in URL.
user_ext	object <json> A valid JSON value containing fields to include under "ext" key in the "user" object of JSON payload. Can contain placeholders same as allowed in URL.

required

object (ThrottlingFeed)

type required	string You can select throttling mode: none - our system will deliver your impressions without any speed limits. manual (legacy) - you can manually reduce traffic speed by chosen percentage. auto - you can set maximal number of impressions or amount of spending per time unit. manual
speed required	number <float> [ 0.1 .. 100 ] Choose your campaign speed

required

object (Categories)

list required	Array of numbers <int32> (list) [ items <int32 > ] retrieve values from GET categories or leave empty to retrieve all categories
include_subcategories required	boolean (include_subcategories)

required

object (Countries)

codes required	Array of strings retrieve values from GET countries or leave empty to retrieve all countries
regions required	Array of strings In order to enable region targeting, you have to select up to three countries above retrieve values from GET regions or leave empty to retrieve all regions If only regions assigned for one of the countries then add the rest country codes as a regions

required

object (Society)

language_mode required	string (language_mode) Enum: "any" "first" "exact" retrieve values from GET language modes any - You will get traffic from visitors whose browser provides any of the languages you are targeting. first - You will get traffic from visitors whose first (primary) language matches your language targeting. exact - You will get traffic from only visitors whose provided languages all match your language targeting.
languages required	Array of strings (languages) retrieve ids from GET languages or leave empty to retrieve all languages
populations required	Array of numbers <int32> (populations) [ items <int32 > ] retrieve ids from GET populations or leave empty to retrieve all populations

required

object (Environment)

os required	Array of numbers <int32> [ items <int32 > ] retrieve ids from GET os or leave empty to retrieve all operating systems
browser required	Array of numbers <int32> [ items <int32 > ] retrieve ids from GET browser or leave empty to retrieve all browsers
resolutions required	Array of numbers <int32> [ items <int32 > ] retrieve ids from GET resolutions or leave empty to retrieve all resolutions

required

object (Device)

device required	Array of numbers <int32> [ items <int32 > ] retrieve ids from GET device or leave empty to retrieve all devices
form_factor required	Array of numbers <int32> [ items <int32 > ] retrieve ids from GET form_factor or leave empty to retrieve all form factors
request_as_desktop	number <int32> Enum: 0 1 Both Android and iOS mobile browsers offer a "Request as Desktop" feature that makes the mobile browser render pages as if on a notebook/desktop device. That feature also fakes the browser identification, so it no longer identifies as a mobile device. We can detect that and correctly identify what the device really is.

required

object (Connection)

ip_targeting_id	integer <int32> Choose one of the predefined IP Targeting List. When is set, all other targeting options are ignored.
conntype required	Array of numbers <int32> [ items <int32 > ] retrieve ids from GET conntype or leave empty to retrieve all connection types
connspeed required	Array of numbers <int32> [ items <int32 > ] retrieve ids from GET connspeed or leave empty to retrieve all connection speeds
internet_service_providers required	Array of numbers <int32> [ items <int32 > ] retrieve ids from GET internet_service_providers or leave empty to retrieve all internet service providers In order to enable ISP targeting, you have to select up to three countries in Countries object codes.

required

object (Time)

timezone required	string (timezone) retrieve ids from GET timezone Select the timezone you would like the the start and end times be in.
time required	Array of strings (time) retrieve ids from GET time Select the time you would like the the start and end times be in.

required

object (WebsiteTargeting)

items_incl required	Array of numbers <int32> (items_incl) [ items <int32 > ]
type required	string include - You can specify a list of websites you want to target. exclude - you will get traffic from all websites in our network matching your targeting options excluding the websites you added. none - You will get traffic from all websites in our network matching your targeting options. include

required

object (AdScore)

valid_traffic required	number <int32> (valid_traffic) Enum: 0 1 Valid Traffic represents visitors that we consider to be real humans, using residential connections that have the ability to see your landing page. This is the traffic type that is advised for all our advertisers.
proxy_traffic required	number <int32> (proxy_traffic) Enum: 0 1 Proxy Traffic represent visitors that we consider to be real humans, however they employ technology to spoof their geolocation, like Proxies, VPN, Hola etc. Depending on your campaign needs, you may want to buy such traffic (it will be cheaper than Valid Traffic).
junk_traffic required	number <int32> (junk_traffic) Enum: 0 1 Junk Traffic represents visitors that we consider to be real humans, however they use very low performance hardware or highly outdated software. Depending on your campaign needs, you may want to buy such traffic (it will be cheaper than Valid Traffic).
bot_traffic required	number <int32> (bot_traffic) Value: 0 Bot Traffic represents visitors that we believe might not be real humans, or people that modified their browser to fake its User Agent. We do not resell such traffic.
compliance_intelligence required	number <int32> (compliance_intelligence) Value: 1 Enforcing compliance will ensure that you are not buying traffic from any websites that are blacklisted by: Operation Creative IWL WIPO ALERT Project Arachnid
compliance required	number <int32> (compliance) Value: 1 Automatically blocks traffic from websites containing potentially illegal content like high risk torrent websites, child abuse or terrorism related content.

Responses

Request samples

Payload

Content type

application/json

{"general_information": {"name": "floatingbanner - throttling none -  website id",
"urls": ["https://www.myurl1.com/test"
],
"minimum_quality": 1,
"minimum_quality_mode": "exact",
"ad_type": "floatingbanner",
"ad_block": "all",
"bid_modifier": 0,
"referrer": 2,
"primespot": "no_primespot",
"position": "top-left",
"floating_url": "https://www.myurl1.com/test2",
"width": "550px",
"height": "250px",
"incognito": "all"
},
"openrtb": {"root_ext": {"sub": "[WEBSITEID]"
},
"user_ext": {"remote_addr": "[IP]",
"x_forwarded_for": "[XFOFO]"
}
},
"throttling": {"type": "none"
},
"categories": {"list": [1,
2,
3
],
"include_subcategories": true
},
"countries": {"codes": ["AM",
"AS",
"AZ"
],
"regions": [ ]
},
"society": {"language_mode": "exact",
"languages": ["af",
"hu"
],
"populations": [4,
8
]
},
"environment": {"os": [91
],
"browser": [194
],
"resolutions": [4,
10
]
},
"device": {"device": [ ],
"form_factor": [ ],
"request_as_desktop": 0
},
"connections": {"ip_targeting_id": 75279
},
"time": {"time": [101,
201,
301
],
"timezone": "Detect"
},
"website_targeting": {"type": "none",
"id": 9603
},
"adscore": {"valid_traffic": 1,
"proxy_traffic": 1,
"junk_traffic": 0,
"bot_traffic": 0,
"compliance_intelligence": 1,
"compliance": 1
}
}

Response samples

200
400
404
500

Content type

application/json

{"status": "success",
"code": 200,
"records": 1,
"messages": "Your campaign has been updated",
"data": {"id": 12345,
"status": "Paused",
"general_information": {"name": "update floatingbanner feed",
"urls": ["https://www.myurl1.com/test"
],
"minimum_quality": 1,
"minimum_quality_mode": "exact",
"ad_type": "floatingbanner",
"ad_block": "all",
"bid_modifier": 0,
"referrer": 2,
"primespot": "no_primespot",
"position": "top-left",
"floating_url": "https://www.myurl1.com/test2",
"width": "550px",
"height": "250px",
"incognito": "all"
},
"openrtb": {"root_ext": {"sub": "[WEBSITEID]"
},
"user_ext": {"remote_addr": "[IP]",
"x_forwarded_for": "[XFOFO]"
}
},
"throttling": {"type": "none"
},
"categories": {"list": [1,
2,
3
],
"include_subcategories": true
},
"countries": {"codes": ["AM",
"AS",
"AZ"
],
"regions": [ ]
},
"society": {"language_mode": "exact",
"languages": ["af",
"hu"
],
"populations": [4,
8
]
},
"environment": {"os": [91
],
"browser": [194
],
"resolutions": [4,
10
]
},
"device": {"device": [ ],
"form_factor": [ ],
"request_as_desktop": 0
},
"connections": {"ip_targeting_id": 75279
},
"time": {"time": [101,
201,
301
],
"timezone": "Detect"
},
"website_targeting": {"type": "none",
"id": 9603
},
"adscore": {"valid_traffic": 1,
"proxy_traffic": 1,
"junk_traffic": 0,
"bot_traffic": 0,
"compliance_intelligence": 1,
"compliance": 1
}
}
}

Patch Feed

Authorizations:

ApiAccessToken

path Parameters

feedId

integer <int64>

feed id

Request Body schema: application/json
required

object (FeedGeneralInformation-2)

name	string [ 1 .. 100 ] characters Choose a name for your campaign, for example: PopAds.
urls	Array of strings <uri> = 1 items [ items <uri > ] Choose your landing page url, for example http://www.popads.net. Do not forget about http:// or https:// in front of the url.
minimum_quality	integer <int32> [ 1 .. 10 ] Please choose carefully the quality of the websites you would like to advertise on. If you choose the minimal website quality too high, you will get less traffic and it will be more expensive. Retrieve values from GET Quality
minimum_quality_mode	string Enum: "minimum" "exact" Retrieve values from GET Quality mode
primespot	string Enum: "all" "primespot" "no_primespot" PrimeSpot bidding occurs when visitor hasn't received a popunder for last hour.PrimeSpot bidding occurs when visitor hasn't received a popunder for last hour. Retrieve values from GET Prime spot
referrer	integer [ 0 .. 2 ] When set to Blank, campaign will be loaded without referrer URL. Retrieve values from GET categories
ad_block	string Enum: "all" "adblock" "no_adblock" Specifies, whether to include visitors with Adblock enabled or no Adblock. Retrieve values from GET Ad block
incognito	string Enum: "all" "incognito" "no_incognito" Choose if campaign should be shown in incognito mode. Retrieve values from GET Incognito
ad_type	string Specifies, in what manner your campaign should be presented to visitors. Retrieve values from GET Advertise type popup
bid_modifier	number <int32> [ 0 .. 100 ] Enter a bid modifier in % (for example, "80" means 80% of returned bid)
ad_type_other	boolean Allow other methods when the chosen one is not available

object (OpenRTB)

Use this section only if your feed is using OpenRTB protocol. For normal XML/JSON feeds, leave all fields on this tab blank.

root_ext	object <json> A valid JSON value containing fields to include under "ext" key in root of JSON payload. Can contain placeholders same as allowed in URL.
imp_ext	object <json> A valid JSON value containing fields to include under "ext" key in the "imp" object of JSON payload. Can contain placeholders same as allowed in URL.
site_ext	object <json> A valid JSON value containing fields to include under "ext" key in the "site" object of JSON payload. Can contain placeholders same as allowed in URL.
device_ext	object <json> A valid JSON value containing fields to include under "ext" key in the "device" object of JSON payload. Can contain placeholders same as allowed in URL.
user_ext	object <json> A valid JSON value containing fields to include under "ext" key in the "user" object of JSON payload. Can contain placeholders same as allowed in URL.

object (ThrottlingFeed-2)

type	string You can select throttling mode: none - our system will deliver your impressions without any speed limits. manual (legacy) - you can manually reduce traffic speed by chosen percentage. auto - you can set maximal number of impressions or amount of spending per time unit. manual
speed	number <float> [ 0.1 .. 100 ] Choose your campaign speed

object (Categories-2)

list	Array of numbers <int32> [ items <int32 > ] retrieve values from GET categories or leave empty to retrieve all categories
include_subcategories	boolean

object (Countries-2)

codes	Array of strings retrieve values from GET countries or leave empty to retrieve all countries
regions	Array of strings In order to enable region targeting, you have to select up to three countries above retrieve values from GET regions or leave empty to retrieve all regions If only regions assigned for one of the countries then add the rest country codes as a regions

object (Society-2)

language_mode	string Enum: "any" "first" "exact" retrieve values from GET language modes any - You will get traffic from visitors whose browser provides any of the languages you are targeting. first - You will get traffic from visitors whose first (primary) language matches your language targeting. exact - You will get traffic from only visitors whose provided languages all match your language targeting.
languages	Array of strings retrieve ids from GET languages or leave empty to retrieve all languages
populations	Array of numbers <int32> [ items <int32 > ] retrieve ids from GET populations or leave empty to retrieve all populations

object (Environment-2)

os	Array of numbers <int32> [ items <int32 > ] retrieve ids from GET os or leave empty to retrieve all operating systems
browser	Array of numbers <int32> [ items <int32 > ] retrieve ids from GET browser or leave empty to retrieve all browsers
resolutions	Array of numbers <int32> [ items <int32 > ] retrieve ids from GET resolutions or leave empty to retrieve all resolutions

object (Device-2)

device	Array of numbers <int32> [ items <int32 > ] retrieve ids from GET device or leave empty to retrieve all devices
form_factor	Array of numbers <int32> [ items <int32 > ] retrieve ids from GET form_factor or leave empty to retrieve all form factors
request_as_desktop	number <int32> Enum: 0 1 Both Android and iOS mobile browsers offer a "Request as Desktop" feature that makes the mobile browser render pages as if on a notebook/desktop device. That feature also fakes the browser identification, so it no longer identifies as a mobile device. We can detect that and correctly identify what the device really is.

object (Connection-2)

ip_targeting_id	integer <int32> Choose one of the predefined IP Targeting List. When is set, all other targeting options are ignored.
conntype	Array of numbers <int32> [ items <int32 > ] retrieve ids from GET conntype or leave empty to retrieve all connection types
connspeed	Array of numbers <int32> [ items <int32 > ] retrieve ids from GET connspeed or leave empty to retrieve all connection speeds
internet_service_providers	Array of numbers <int32> [ items <int32 > ] retrieve ids from GET internet_service_providers or leave empty to retrieve all internet service providers In order to enable ISP targeting, you have to select up to three countries in Countries object codes.

object (Time-2)

time	Array of strings retrieve ids from GET time Select the time you would like the the start and end times be in.
timezone	string retrieve ids from GET timezone Select the timezone you would like the the start and end times be in.

object (WebsiteTargeting-2)

items_incl	Array of numbers <int32> [ items <int32 > ]
type	string include - You can specify a list of websites you want to target. exclude - you will get traffic from all websites in our network matching your targeting options excluding the websites you added. none - You will get traffic from all websites in our network matching your targeting options. include

object (AdScore-2)

valid_traffic	number <int32> Enum: 0 1 Valid Traffic represents visitors that we consider to be real humans, using residential connections that have the ability to see your landing page. This is the traffic type that is advised for all our advertisers.
proxy_traffic	number <int32> Enum: 0 1 Proxy Traffic represent visitors that we consider to be real humans, however they employ technology to spoof their geolocation, like Proxies, VPN, Hola etc. Depending on your campaign needs, you may want to buy such traffic (it will be cheaper than Valid Traffic).
true_location	number <int32> Enum: 0 1 Try to determine real visitor's country for Proxy Traffic. Assigned only when proxy_traffic = 1 and conntype = 7 (Connection object).
junk_traffic	number <int32> Enum: 0 1 Junk Traffic represents visitors that we consider to be real humans, however they use very low performance hardware or highly outdated software. Depending on your campaign needs, you may want to buy such traffic (it will be cheaper than Valid Traffic).
bot_traffic	number <int32> Value: 0 Bot Traffic represents visitors that we believe might not be real humans, or people that modified their browser to fake its User Agent. We do not resell such traffic.
compliance_intelligence	number <int32> Value: 1 Enforcing compliance will ensure that you are not buying traffic from any websites that are blacklisted by: Operation Creative IWL WIPO ALERT Project Arachnid
compliance	number <int32> Value: 1 Automatically blocks traffic from websites containing potentially illegal content like high risk torrent websites, child abuse or terrorism related content.

Responses

Request samples

Payload

Content type

application/json

{"general_information": {"ad_type": "floatingbanner",
"position": "top-left",
"floating_url": "https://www.myurl1.com/test2",
"width": "550px",
"height": "250px"
}
}

Response samples

200
404
500

Content type

application/json

{"status": "success",
"code": 200,
"records": 1,
"messages": "Your campaign has been updated",
"data": {"id": 12345,
"status": "Paused",
"general_information": {"name": "update floatingbanner feed",
"urls": ["https://www.myurl1.com/test"
],
"minimum_quality": 1,
"minimum_quality_mode": "exact",
"ad_type": "floatingbanner",
"ad_block": "all",
"bid_modifier": 0,
"referrer": 2,
"primespot": "no_primespot",
"position": "top-left",
"floating_url": "https://www.myurl1.com/test2",
"width": "550px",
"height": "250px",
"incognito": "all"
},
"openrtb": {"root_ext": {"sub": "[WEBSITEID]"
},
"user_ext": {"remote_addr": "[IP]",
"x_forwarded_for": "[XFOFO]"
}
},
"throttling": {"type": "none"
},
"categories": {"list": [1,
2,
3
],
"include_subcategories": true
},
"countries": {"codes": ["AM",
"AS",
"AZ"
],
"regions": [ ]
},
"society": {"language_mode": "exact",
"languages": ["af",
"hu"
],
"populations": [4,
8
]
},
"environment": {"os": [91
],
"browser": [194
],
"resolutions": [4,
10
]
},
"device": {"device": [ ],
"form_factor": [ ],
"request_as_desktop": 0
},
"connections": {"ip_targeting_id": 75279
},
"time": {"time": [101,
201,
301
],
"timezone": "Detect"
},
"website_targeting": {"type": "none",
"id": 9603
},
"adscore": {"valid_traffic": 1,
"proxy_traffic": 1,
"junk_traffic": 0,
"bot_traffic": 0,
"compliance_intelligence": 1,
"compliance": 1
}
}
}

options

Endpoints to retrieve various option values that can be used in campaigns and feeds. These include lists of available targeting options such as devices, operating systems, browsers, countries, and more, enabling advertisers to refine their campaign settings.

Retrieve ad block values

Information about ad block

Authorizations:

ApiAccessToken

Responses

Response samples

200

Content type

application/json

{"status": "success",
"code": 200,
"records": 2,
"data": [{"id": "all",
"label": "All traffic"
},
{"id": "adblock",
"label": "Adblock only"
}
]
}

Retrieve advertise type

Information about advertise type

Authorizations:

ApiAccessToken

Responses

Response samples

200

Content type

application/json

{"status": "success",
"code": 200,
"records": 1,
"data": {"id": "popunder",
"label": "Popunder"
}
}

Retrieve after approve values

Information about after approve

Authorizations:

ApiAccessToken

Responses

Response samples

200

Content type

application/json

{"status": "success",
"code": 200,
"records": 2,
"data": {"id": 1,
"label": "Start"
}
}

Retrieve browsers

Information about browsers

Authorizations:

ApiAccessToken

Responses

Response samples

200

Content type

application/json

{"status": "success",
"code": 200,
"records": 1,
"data": {"id": 2,
"type": "browser",
"parent_id": null,
"name": "Unknown",
"depth": 1
}
}

Retrieve categories

Information about categories

Authorizations:

ApiAccessToken

Responses

Response samples

200

Content type

application/json

{"status": "success",
"code": 200,
"records": 2,
"data": [{"id": 253,
"label": "General",
"parent_id": null
},
{"id": 1,
"label": "General/Arts",
"parent_id": 253
}
]
}

Retrieve connection speeds

Information about connection speeds

Authorizations:

ApiAccessToken

Responses

Response samples

200

Content type

application/json

{"status": "success",
"code": 200,
"records": 1,
"data": {"id": 0,
"label": "Unknown"
}
}

Retrieve connection types

Information about connection types

Authorizations:

ApiAccessToken

Responses

Response samples

200

Content type

application/json

{"status": "success",
"code": 200,
"records": 1,
"data": {"id": 0,
"label": "Unknown"
}
}

Retrieve countries

Information about countries

Authorizations:

ApiAccessToken

Responses

Response samples

200

Content type

application/json

{"status": "success",
"code": 200,
"records": 1,
"data": {"id": "AD",
"label": "Andorra"
}
}

Retrieve daily traffic shaping options

Information about daily traffic shaping

Authorizations:

ApiAccessToken

Responses

Response samples

200

Content type

application/json

{"status": "success",
"code": 200,
"records": 1,
"data": {"id": "adaptive",
"label": "Adaptive"
}
}

Retrieve floating mode positions

Information about floating mode positions

Authorizations:

ApiAccessToken

Responses

Response samples

200

Content type

application/json

{"status": "success",
"code": 200,
"records": 1,
"data": {"id": "top-left",
"label": "Top left"
}
}

Retrieve form factors

Information about form factors

Authorizations:

ApiAccessToken

Responses

Response samples

200

Content type

application/json

{"status": "success",
"code": 200,
"records": 1,
"data": {"id": 4,
"type": "form_factor",
"parent_id": null,
"name": "Unknown",
"depth": 1
}
}

Retrieve frequency cap days

Information about frequency cap days

Authorizations:

ApiAccessToken

Responses

Response samples

200

Content type

application/json

{"status": "success",
"code": 200,
"records": 1,
"data": {"id": 0,
"label": "0 days"
}
}

Retrieve frequency cap hours

Information about frequency cap hours

Authorizations:

ApiAccessToken

Responses

Response samples

200

Content type

application/json

{"status": "success",
"code": 200,
"records": 1,
"data": {"id": 0,
"label": "0 hours"
}
}

Retrieve frequency cap minutes

Information about frequency cap minutes

Authorizations:

ApiAccessToken

Responses

Response samples

200

Content type

application/json

{"status": "success",
"code": 200,
"records": 1,
"data": {"id": 0,
"label": "0 minutes"
}
}

Retrieve devices

Information about all devices

Authorizations:

ApiAccessToken

Responses

Response samples

200

Content type

application/json

{"status": "success",
"code": 200,
"records": 1,
"data": {"id": 3,
"type": "device",
"parent_id": null,
"name": "Unknown",
"depth": 1
}
}

Retrieve Incognito mode values

Specifies, whether to include visitors browsing only in Incognito mode.

Authorizations:

ApiAccessToken

Responses

Response samples

200

Content type

application/json

{"status": "success",
"code": 200,
"records": 3,
"data": [{"id": "all",
"label": "All traffic"
},
{"id": "incognito",
"label": "Incognito only"
},
{"id": "regular",
"label": "Non-Incognito traffic only"
}
]
}

Retrieve internet service providers

Information about internet service providers. Multiple values can provided with comma separated codes values

Authorizations:

ApiAccessToken

query Parameters

codes

string

one or more separated with comma get all the valid values from Countries

Responses

Response samples

200

Content type

application/json

{"status": "success",
"code": 200,
"records": 2,
"data": [{"id": 2543477,
"name": "Cosmote",
"country": "GR",
"connection_speed": [2,
4,
0
],
"connection_type": [10,
3,
0
]
},
{"id": 2500849,
"name": "Vodafone Greece",
"country": "GR",
"connection_speed": [2,
0,
3
],
"connection_type": [10,
0,
7
]
}
]
}

Retrieve language modes

Information about language modes

Authorizations:

ApiAccessToken

Responses

Response samples

200

Content type

application/json

{"status": "success",
"code": 200,
"records": 2,
"data": [{"id": "any",
"label": "Any match"
},
{"id": "first",
"label": "First match"
}
]
}

Retrieve languages

Information about languages

Authorizations:

ApiAccessToken

Responses

Response samples

200

Content type

application/json

{"status": "success",
"code": 200,
"records": 2,
"data": [{"id": "af",
"label": "Afrikaans"
},
{"id": "sq",
"label": "Albanian"
}
]
}

Retrieve operating systems

Information about operating systems

Authorizations:

ApiAccessToken

Responses

Response samples

200

Content type

application/json

{"status": "success",
"code": 200,
"records": 2,
"data": [{"id": 1,
"type": "os",
"parent_id": null,
"name": "Unknown",
"depth": 1
},
{"id": 7,
"type": "os",
"parent_id": null,
"name": "Windows",
"depth": 1
}
]
}

Retrieve populations

Information about populations

Authorizations:

ApiAccessToken

Responses

Response samples

200

Content type

application/json

{"status": "success",
"code": 200,
"records": 2,
"data": [{"id": 0,
"label": "Unknown"
},
{"id": 1,
"label": "1 - 30,000"
}
]
}

Retrieve prime spot values

Information about prime spot

Authorizations:

ApiAccessToken

Responses

Response samples

200

Content type

application/json

{"status": "success",
"code": 200,
"records": 2,
"data": [{"id": "all",
"label": "All traffic"
},
{"id": "primespot",
"label": "PrimeSpot only"
}
]
}

Retrieve quality

Information about quality

Authorizations:

ApiAccessToken

Responses

Response samples

200

Content type

application/json

{"status": "success",
"code": 200,
"records": 2,
"data": [{"id": 10,
"label": "Rated 10/10"
},
{"id": 9,
"label": "Rated 9/10"
}
]
}

Retrieve quality mode

Information about quality mode

Authorizations:

ApiAccessToken

Responses

Response samples

200

Content type

application/json

{"status": "success",
"code": 200,
"records": 2,
"data": [{"id": "minimum",
"label": "At least"
},
{"id": "exact",
"label": "Exactly"
}
]
}

Retrieve referrer values

Information about the referrer

Authorizations:

ApiAccessToken

query Parameters

key

required

string

api key

Responses

Response samples

200

Content type

application/json

{"status": "success",
"code": 200,
"records": 2,
"data": [{"id": 0,
"label": "Standard"
},
{"id": 1,
"label": "Blank"
},
{"id": 2,
"label": "Random"
}
]
}

Retrieve regions by specific country

Information about regions by country(ies)

Authorizations:

ApiAccessToken

query Parameters

codes

string

one or more separated with comma get all the valid values from Countries

Responses

Response samples

200

Content type

application/json

{"status": "success",
"code": 200,
"records": 2,
"data": [{"id": "GR01",
"label": "Evros"
},
{"id": "GR02",
"label": "Rodhopi"
}
]
}

Retrieve resolutions

Information about resolutions

Authorizations:

ApiAccessToken

Responses

Response samples

200

Content type

application/json

{"status": "success",
"code": 200,
"records": 2,
"data": [{"id": 0,
"label": "Unknown"
},
{"id": 1,
"label": "800x600"
}
]
}

Retrieve time values

Information about time

Authorizations:

ApiAccessToken

Responses

Response samples

200

Content type

application/json

{"status": "success",
"code": 200,
"records": 2,
"data": [{"id": "000",
"label": "000"
},
{"id": "001",
"label": "001"
}
]
}

Retrieve timezones

Information about timezones

Authorizations:

ApiAccessToken

Responses

Response samples

200

Content type

application/json

{"status": "success",
"code": 200,
"records": 2,
"data": [{"id": "Detect",
"label": "Detect My Timezone"
},
{"id": "Africa/Abidjan",
"label": "Africa/Abidjan"
}
]
}

PopAds API v2 (2.2.1)

campaign

Retrieve campaign details

Authorizations:

path Parameters

Responses

Response samples

Create a new Campaign

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Update Campaign

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Patch Campaign

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

feed

Retrieve feed details

Authorizations:

path Parameters

Responses

Response samples

Create a new feed

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Update Feed

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Patch Feed

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

options

Retrieve ad block values

Authorizations:

Responses

Response samples

Retrieve advertise type

Authorizations:

Responses

Response samples

Retrieve after approve values

Authorizations:

Responses

Response samples

Retrieve browsers

Authorizations:

Responses

Response samples

Retrieve categories

Authorizations:

Responses

Response samples

Retrieve connection speeds

Authorizations:

Responses

Response samples

Retrieve connection types

Authorizations:

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required