PopAds API v2 (2.0.0)

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.

Create a new Campaign

query Parameters
key
required
string

api key

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

ad_type_other
required
boolean

Allow other methods when the chosen one is not available

required
object (Budget)
mode
required
string

Type of Budget

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

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.

global_budget
boolean

Allows to create campaigns using account's balance instead of local budgets.

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.
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
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> [ items <int32 > ]

retrieve values from GET categories
or leave empty to retrieve all categories

include_subcategories
required
boolean
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
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

retrieve ids from GET languages
or leave empty to retrieve all languages

populations
required
Array of numbers <int32> [ 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 nunber <int32> [ items <int32 > ]

retrieve ids from GET conntype
or leave empty to retrieve all connection types

connspeed
required
Array of nunber <int32> [ items <int32 > ]

retrieve ids from GET connspeed
or leave empty to retrieve all connection speeds

internet_service_providers
required
Array of nunber <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)
time
required
Array of strings

retrieve ids from GET time Select the time you would like the the start and end times be in.

timezone
required
string

retrieve ids from GET timezone Select the timezone you would like the the start and end times be in.

required
object (WebsiteTargeting)
items_incl
required
Array of numbers <int32> [ 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.
required
object (AdScore)
valid_traffic
required
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
required
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
required
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
required
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
required
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
required
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

Content type
application/json
Example
{
  • "general_information": {
    },
  • "budget": {
    },
  • "throttling": {
    },
  • "categories": {
    },
  • "countries": {
    },
  • "society": {
    },
  • "environment": {
    },
  • "device": {
    },
  • "connections": {
    },
  • "time": {
    },
  • "website_targeting": {
    },
  • "adscore": {
    }
}

Response samples

Content type
application/json
Example
{
  • "status": "success",
  • "code": 201,
  • "records": 1,
  • "messages": [
    ],
  • "data": {
    }
}

Update Campaign

path Parameters
campaignId
required
integer <int64>

campaign id

query Parameters
key
required
string

api key

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

ad_type_other
required
any
required
object (Budget-2)
mode
required
string

Type of Budget

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

global_budget
boolean

Allows to create campaigns using account's balance instead of local budgets.

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.
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
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> [ items <int32 > ]

retrieve values from GET categories
or leave empty to retrieve all categories

include_subcategories
required
boolean
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
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

retrieve ids from GET languages
or leave empty to retrieve all languages

populations
required
Array of numbers <int32> [ 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 nunber <int32> [ items <int32 > ]

retrieve ids from GET conntype
or leave empty to retrieve all connection types

connspeed
required
Array of nunber <int32> [ items <int32 > ]

retrieve ids from GET connspeed
or leave empty to retrieve all connection speeds

internet_service_providers
required
Array of nunber <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)
time
required
Array of strings

retrieve ids from GET time Select the time you would like the the start and end times be in.

timezone
required
string

retrieve ids from GET timezone Select the timezone you would like the the start and end times be in.

required
object (WebsiteTargeting)
items_incl
required
Array of numbers <int32> [ 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.
required
object (AdScore)
valid_traffic
required
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
required
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
required
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
required
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
required
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
required
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

Content type
application/json
Example
{
  • "general_information": {},
  • "budget": {
    },
  • "throttling": {
    },
  • "categories": {
    },
  • "society": {
    },
  • "environment": {
    },
  • "device": {
    },
  • "countries": {
    },
  • "connections": {
    },
  • "time": {
    },
  • "website_targeting": {
    },
  • "adscore": {
    }
}

Response samples

Content type
application/json
Example
{
  • "status": "success",
  • "code": 200,
  • "records": 1,
  • "messages": [
    ],
  • "data": null,
  • "campaign": {
    }
}

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.

Create a new feed

query Parameters
key
required
string

api key

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

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.
speed
required
float [ 0.1 .. 100 ]

Choose your campaign speed

required
object (Categories)
list
required
Array of numbers <int32> [ items <int32 > ]

retrieve values from GET categories
or leave empty to retrieve all categories

include_subcategories
required
boolean
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
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

retrieve ids from GET languages
or leave empty to retrieve all languages

populations
required
Array of numbers <int32> [ 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 nunber <int32> [ items <int32 > ]

retrieve ids from GET conntype
or leave empty to retrieve all connection types

connspeed
required
Array of nunber <int32> [ items <int32 > ]

retrieve ids from GET connspeed
or leave empty to retrieve all connection speeds

internet_service_providers
required
Array of nunber <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)
time
required
Array of strings

retrieve ids from GET time Select the time you would like the the start and end times be in.

timezone
required
string

retrieve ids from GET timezone Select the timezone you would like the the start and end times be in.

required
object (WebsiteTargeting)
items_incl
required
Array of numbers <int32> [ 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.
required
object (AdScore)
valid_traffic
required
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
required
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
required
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
required
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
required
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
required
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

Content type
application/json

Example request body for feed creation for floating banner

{
  • "general_information": {
    },
  • "openrtb": {
    },
  • "throttling": {
    },
  • "categories": {
    },
  • "countries": {
    },
  • "society": {
    },
  • "environment": {
    },
  • "device": {
    },
  • "connections": {
    },
  • "time": {
    },
  • "website_targeting": {
    },
  • "adscore": {
    }
}

Response samples

Content type
application/json

Example response body for feed creation for floating banner

{
  • "status": "success",
  • "code": 200,
  • "records": 1,
  • "data": {
    }
}

Update Feed

path Parameters
feedId
required
integer <int64>

feed id

query Parameters
key
required
string

api key

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

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.
speed
required
float [ 0.1 .. 100 ]

Choose your campaign speed

required
object (Categories)
list
required
Array of numbers <int32> [ items <int32 > ]

retrieve values from GET categories
or leave empty to retrieve all categories

include_subcategories
required
boolean
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
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

retrieve ids from GET languages
or leave empty to retrieve all languages

populations
required
Array of numbers <int32> [ 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 nunber <int32> [ items <int32 > ]

retrieve ids from GET conntype
or leave empty to retrieve all connection types

connspeed
required
Array of nunber <int32> [ items <int32 > ]

retrieve ids from GET connspeed
or leave empty to retrieve all connection speeds

internet_service_providers
required
Array of nunber <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)
time
required
Array of strings

retrieve ids from GET time Select the time you would like the the start and end times be in.

timezone
required
string

retrieve ids from GET timezone Select the timezone you would like the the start and end times be in.

required
object (WebsiteTargeting)
items_incl
required
Array of numbers <int32> [ 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.
required
object (AdScore)
valid_traffic
required
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
required
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
required
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
required
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
required
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
required
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

Content type
application/json
{
  • "general_information": {
    },
  • "openrtb": {
    },
  • "throttling": {
    },
  • "categories": {
    },
  • "countries": {
    },
  • "society": {
    },
  • "environment": {
    },
  • "device": {
    },
  • "connections": {
    },
  • "time": {
    },
  • "website_targeting": {
    },
  • "adscore": {
    }
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "records": 1,
  • "messages": "Your campaign has been updated",
  • "data": {
    }
}

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

query Parameters
key
required
string

api key

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "records": 2,
  • "data": [
    ]
}

Retrieve advertise type

Information about advertise type

query Parameters
key
required
string

api key

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "records": 2,
  • "data": [
    ]
}

Retrieve after approve values

Information about after approve

query Parameters
key
required
string

api key

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "records": 2,
  • "data": [
    ]
}

Retrieve browsers

Information about browsers

query Parameters
key
required
string

api key

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "records": 2,
  • "data": [
    ]
}

Retrieve categories

Information about categories

query Parameters
key
required
string

api key

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "records": 2,
  • "data": [
    ]
}

Retrieve connection speeds

Information about connection speeds

query Parameters
key
required
string

api key

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "records": 2,
  • "data": [
    ]
}

Retrieve connection types

Information about connection types

query Parameters
key
required
string

api key

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "records": 2,
  • "data": [
    ]
}

Retrieve countries

Information about countries

query Parameters
key
required
string

api key

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "records": 2,
  • "data": [
    ]
}

Retrieve floating mode positions

Information about floating mode positions

query Parameters
key
required
string

api key

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "records": 2,
  • "data": [
    ]
}

Retrieve form factors

Information about form factors

query Parameters
key
required
string

api key

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "records": 2,
  • "data": [
    ]
}

Retrieve frequency cap days

Information about frequency cap days

query Parameters
key
required
string

api key

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "records": 2,
  • "data": [
    ]
}

Retrieve frequency cap hours

Information about frequency cap hours

query Parameters
key
required
string

api key

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "records": 2,
  • "data": [
    ]
}

Retrieve frequency cap minutes

Information about frequency cap minutes

query Parameters
key
required
string

api key

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "records": 2,
  • "data": [
    ]
}

Retrieve devices

Information about all devices

query Parameters
key
required
string

api key

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "records": 2,
  • "data": [
    ]
}

Retrieve Incognito mode values

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

query Parameters
key
required
string

api key

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "records": 3,
  • "data": [
    ]
}

Retrieve internet service providers

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

query Parameters
key
required
string

api key

codes
required
string

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

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "records": 2,
  • "data": [
    ]
}

Retrieve language modes

Information about language modes

query Parameters
key
required
string

api key

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "records": 2,
  • "data": [
    ]
}

Retrieve languages

Information about languages

query Parameters
key
required
string

api key

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "records": 2,
  • "data": [
    ]
}

Retrieve operating systems

Information about operating systems

query Parameters
key
required
string

api key

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "records": 2,
  • "data": [
    ]
}

Retrieve populations

Information about populations

query Parameters
key
required
string

api key

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "records": 2,
  • "data": [
    ]
}

Retrieve prime spot values

Information about prime spot

query Parameters
key
required
string

api key

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "records": 2,
  • "data": [
    ]
}

Retrieve quality

Information about quality

query Parameters
key
required
string

api key

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "records": 2,
  • "data": [
    ]
}

Retrieve quality mode

Information about quality mode

query Parameters
key
required
string

api key

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "records": 2,
  • "data": [
    ]
}

Retrieve referrer values

Information about the referrer

query Parameters
key
required
string

api key

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "records": 2,
  • "data": [
    ]
}

Retrieve regions by specific country

Information about regions by country(ies)

query Parameters
key
required
string

api key

codes
required
string

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

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "records": 2,
  • "data": [
    ]
}

Retrieve resolutions

Information about resolutions

query Parameters
key
required
string

api key

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "records": 2,
  • "data": [
    ]
}

Retrieve time values

Information about time

query Parameters
key
required
string

api key

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "records": 2,
  • "data": [
    ]
}

Retrieve timezones

Information about timezones

query Parameters
key
required
string

api key

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "records": 2,
  • "data": [
    ]
}