Targeting Rules API endpoints — Site

Targeting rules for advertisers, campaigns, banners, placements, sites, and zones. 62 site endpoints, generated from the OpenAPI spec. Authentication, the response envelope, pagination and error codes are shared by all endpoints — see REST API overview. Parameters marked form go in an application/x-www-form-urlencoded request body.

The endpoints shared by every level are on Targeting Rules API endpoints.

GET /rest-api/site/{siteId}/targeting/{targetId}.do

Request examples

Get site targeting rule by ID.

Parameter	In	Type	Required	Description
siteId	path	integer	yes	Unique numeric ID of the site
targetId	path	integer	yes	Unique numeric ID of the targeting rule

Responses: 200 — Success · 404 — Site or targeting rule not found · 500 — Internal server error. Errors follow the shared conventions.

DELETE /rest-api/site/{siteId}/targeting/{targetId}/delete.do

Request examples

Delete site targeting rule.

Parameter	In	Type	Required	Description
siteId	path	integer	yes	Unique numeric ID of the site
targetId	path	integer	yes	Unique numeric ID of the targeting rule to delete

Responses: 200 — Success · 404 — Site or targeting rule not found · 500 — Internal server error. Errors follow the shared conventions.

POST /rest-api/site/{siteId}/targeting/api-json-field/create.do

Request examples

Create site API JSON field targeting.

Parameter	In	Type	Required	Description
siteId	path	integer	yes	Unique numeric ID of the site
rule	form	string	yes	Targeting rule type — INCLUDE for whitelist or EXCLUDE for blacklist Values: INCLUDE, EXCLUDE, MATCH, NOT_MATCH.
apiUrl	form	string	yes	External API URL to call for targeting data
jsonField	form	string	yes	JSON field name to extract from the API response
jsonFieldValue	form	string	yes	Expected value of the JSON field to match against

Responses: 200 — Success · 404 — Site not found · 500 — Internal server error. Errors follow the shared conventions.

POST /rest-api/site/{siteId}/targeting/app-package/create.do

Request examples

Create site app package targeting.

Parameter	In	Type	Required	Description
siteId	path	integer	yes	Unique numeric ID of the site
rule	form	string	yes	Targeting rule type — INCLUDE for whitelist or EXCLUDE for blacklist Values: INCLUDE, EXCLUDE, MATCH, NOT_MATCH.
appPackage	form	string	yes	Mobile application package name (e.g. com.example.app)

Responses: 200 — Success · 404 — Site not found · 500 — Internal server error. Errors follow the shared conventions.

POST /rest-api/site/{siteId}/targeting/browser-country/create.do

Request examples

Create site browser country targeting.

Parameter	In	Type	Required	Description
siteId	path	integer	yes	Unique numeric ID of the site
rule	form	string	yes	Targeting rule type — INCLUDE for whitelist or EXCLUDE for blacklist Values: INCLUDE, EXCLUDE, MATCH, NOT_MATCH.
countryCode	form	array<string>	yes	ISO 3166-1 alpha-2 country code(s) to target — repeat the parameter or separate codes with commas (e.g. DE,FR)

Responses: 200 — Success · 404 — Site not found · 500 — Internal server error. Errors follow the shared conventions.

POST /rest-api/site/{siteId}/targeting/browser-rank/create.do

Request examples

Create site browser rank targeting.

Parameter	In	Type	Required	Description
siteId	path	integer	yes	Unique numeric ID of the site
rule	form	string	yes	Targeting rule type — INCLUDE for whitelist or EXCLUDE for blacklist Values: INCLUDE, EXCLUDE, MATCH, NOT_MATCH.
browserRank	form	integer	yes	Browser popularity rank score to target
relation	form	string	no	Comparison relation — LOWER, GREATER, LOWER_EQUAL, GREATER_EQUAL or EQUAL; omitted, it is LOWER_EQUAL Values: LOWER, GREATER, LOWER_EQUAL, GREATER_EQUAL, EQUAL.

Responses: 200 — Success · 404 — Site not found · 500 — Internal server error. Errors follow the shared conventions.

GET /rest-api/site/{siteId}/targeting/browser/chrome/values.do

Request examples

Get Chrome browser version values for site.

Parameter	In	Type	Required	Description
siteId	path	integer	yes	Unique numeric ID of the site

Responses: 200 — Success · 404 — Site not found · 500 — Internal server error. Errors follow the shared conventions.

POST /rest-api/site/{siteId}/targeting/browser/create.do

Request examples

Create site browser targeting.

Parameter	In	Type	Required	Description
siteId	path	integer	yes	Unique numeric ID of the site
browser	form	string	yes	Browser identifier (e.g. CHROME, FIREFOX, SAFARI, EDGE) Values: CHROME_MOBILE, CHROME, MOBILE_SAFARI, SAFARI, EDGE, FIREFOX, OPERA, SAMSUNG_BROWSER, UC_BROWSER, YANDEX, OPERA_MINI, EDGE_MOBILE, QQ_BROWSER, FIREFOX_MOBILE, MIUI_BROWSER, WHALE, HUAWEI_BROWSER, OPERA_MOBILE, BRAVE, BAIDU_BROWSER, YANDEX_BROWSER_IOS, AMAZON_SILK, DUCKDUCKGO, VIVO_BROWSER, ARC … (+44 more, 69 total).
rule	form	string	no	Targeting rule type — INCLUDE for whitelist or EXCLUDE for blacklist Values: INCLUDE, EXCLUDE, MATCH, NOT_MATCH.
relation	form	string	no	Version comparison operator: LOWER, GREATER, LOWER_EQUAL, GREATER_EQUAL, or EQUAL Values: LOWER, GREATER, LOWER_EQUAL, GREATER_EQUAL, EQUAL.
browserVersion	form	string	no	Browser major version number (e.g. ‘80’ or ‘30.0’ — only major version is used)

Responses: 200 — Success · 404 — Site not found · 500 — Internal server error. Errors follow the shared conventions.

GET /rest-api/site/{siteId}/targeting/browser/firefox/values.do

Request examples

Get Firefox browser version values for site.

Parameter	In	Type	Required	Description
siteId	path	integer	yes	Unique numeric ID of the site

Responses: 200 — Success · 404 — Site not found · 500 — Internal server error. Errors follow the shared conventions.

GET /rest-api/site/{siteId}/targeting/browser/ie/values.do

Request examples

Get IE browser version values for site.

Parameter	In	Type	Required	Description
siteId	path	integer	yes	Unique numeric ID of the site

Responses: 200 — Success · 404 — Site not found · 500 — Internal server error. Errors follow the shared conventions.

GET /rest-api/site/{siteId}/targeting/browser/safari/values.do

Request examples

Get Safari browser version values for site.

Parameter	In	Type	Required	Description
siteId	path	integer	yes	Unique numeric ID of the site

Responses: 200 — Success · 404 — Site not found · 500 — Internal server error. Errors follow the shared conventions.

GET /rest-api/site/{siteId}/targeting/browser/values.do

Request examples

Get browser targeting values for site.

Parameter	In	Type	Required	Description
siteId	path	integer	yes	Unique numeric ID of the site

Responses: 200 — Success · 404 — Site not found · 500 — Internal server error. Errors follow the shared conventions.

POST /rest-api/site/{siteId}/targeting/channel/create.do

Request examples

Create site channel targeting.

Parameter	In	Type	Required	Description
siteId	path	integer	yes	Unique numeric ID of the site
rule	form	string	yes	Targeting rule type — INCLUDE for whitelist or EXCLUDE for blacklist Values: INCLUDE, EXCLUDE, MATCH, NOT_MATCH.
channel	form	string	yes	Channel identifier string to target

Responses: 200 — Success · 404 — Site not found · 500 — Internal server error. Errors follow the shared conventions.

POST /rest-api/site/{siteId}/targeting/connection-type/create.do

Request examples

Create site connection type targeting.

Parameter	In	Type	Required	Description
siteId	path	integer	yes	Unique numeric ID of the site
rule	form	string	yes	Targeting rule type — INCLUDE for whitelist or EXCLUDE for blacklist Values: INCLUDE, EXCLUDE, MATCH, NOT_MATCH.
connectionType	form	string	yes	Connection type to target Values: UNKNOWN, DIALUP, CABLE_DSL, CORPORATE, CELLULAR, WI_FI.

Responses: 200 — Success · 404 — Site not found · 500 — Internal server error. Errors follow the shared conventions.

GET /rest-api/site/{siteId}/targeting/connection-type/values.do

Request examples

Get connection type values.

Parameter	In	Type	Required	Description
siteId	path	integer	yes	Unique numeric ID of the site

Responses: 200 — Success · 404 — Not found — resource does not exist. Errors follow the shared conventions.

POST /rest-api/site/{siteId}/targeting/cookie-value/create.do

Request examples

Create site cookie value targeting.

Parameter	In	Type	Required	Description
siteId	path	integer	yes	Unique numeric ID of the site
rule	form	string	yes	Targeting rule type — INCLUDE for whitelist or EXCLUDE for blacklist Values: INCLUDE, EXCLUDE, MATCH, NOT_MATCH.
cookieName	form	string	yes	Name of the cookie to match against
cookieValue	form	string	yes	Expected value of the cookie

Responses: 200 — Success · 404 — Site not found · 500 — Internal server error. Errors follow the shared conventions.

POST /rest-api/site/{siteId}/targeting/country/create.do

Request examples

Create site country targeting.

Parameter	In	Type	Required	Description
siteId	path	integer	yes	Unique numeric ID of the site
rule	form	string	yes	Targeting rule type — INCLUDE for whitelist or EXCLUDE for blacklist Values: INCLUDE, EXCLUDE, MATCH, NOT_MATCH.
countryCode	form	array<string>	yes	ISO 3166-1 alpha-2 country code(s) to target — repeat the parameter or separate codes with commas (e.g. DE,FR)

Responses: 200 — Success · 404 — Site not found · 500 — Internal server error. Errors follow the shared conventions.

GET /rest-api/site/{siteId}/targeting/country/region/city/values.do

Request examples

Get region city values for site.

Parameter	In	Type	Required	Description
countryCode	query	string	yes	ISO alpha-2 country code (e.g. US, GB, DE)
regionName	query	string	yes	Region name within the specified country, as returned by the country regions endpoint
siteId	path	integer	yes	Unique numeric ID of the site

Responses: 200 — Success · 404 — Site not found · 500 — Internal server error. Errors follow the shared conventions.

GET /rest-api/site/{siteId}/targeting/country/region/values.do

Request examples

Get country region values for site.

Parameter	In	Type	Required	Description
countryCode	query	string	yes	ISO alpha-2 country code (e.g. US, GB, DE)
siteId	path	integer	yes	Unique numeric ID of the site

Responses: 200 — Success · 404 — Site not found · 500 — Internal server error. Errors follow the shared conventions.

POST /rest-api/site/{siteId}/targeting/custom/create.do

Request examples

Create site custom parameter targeting.

Parameter	In	Type	Required	Description
siteId	path	integer	yes	Unique numeric ID of the site
rule	form	string	yes	Targeting rule type — INCLUDE for whitelist or EXCLUDE for blacklist Values: INCLUDE, EXCLUDE, MATCH, NOT_MATCH.
customValue	form	string	yes	Custom targeting value or expression (e.g. ($p1==1 || $p1==‘a’) && $p2>=12)
customType	form	string	no	Custom target type — EXPRESSION, VALUE, or SUBSTRING (optional) Values: EXPRESSION, VALUE, ONE_OF, SUBSTRING.
operation	form	string	no	Comparison operation — EQUALS, NOT_EQUALS, CONTAINS, or NOT_CONTAINS (optional, used with VALUE/SUBSTRING) Values: EQUALS, NOT_EQUALS, CONTAINS, NOT_CONTAINS, GREATER, GREATER_OR_EQUALS, LESS, LESS_OR_EQUALS, IN, NOT_IN.
parameter	form	string	no	Parameter name for the operation comparison (optional, used with VALUE/SUBSTRING)

Responses: 200 — Success · 404 — Site not found · 500 — Internal server error. Errors follow the shared conventions.

POST /rest-api/site/{siteId}/targeting/date-time/create.do

Request examples

Create site date/time targeting.

Parameter	In	Type	Required	Description
siteId	path	integer	yes	Unique numeric ID of the site
rule	form	string	yes	Targeting rule type — INCLUDE for whitelist or EXCLUDE for blacklist Values: INCLUDE, EXCLUDE, MATCH, NOT_MATCH.
timeFrom	form	string	yes	Time range start in HH:mm format
timeTo	form	string	yes	Time range end in HH:mm format
dayOfWeek	form	array<string>	no	Days of week to target; omitted, the rule applies on every day Values: MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY.
clientLocalTime	form	boolean	no	When true, use client’s local time zone for time range evaluation

Responses: 200 — Success · 404 — Site not found · 500 — Internal server error. Errors follow the shared conventions.

POST /rest-api/site/{siteId}/targeting/day-of-week/create.do

Request examples

Create site day of week targeting.

Parameter	In	Type	Required	Description
siteId	path	integer	yes	Unique numeric ID of the site
rule	form	string	yes	Targeting rule type — INCLUDE for whitelist or EXCLUDE for blacklist Values: INCLUDE, EXCLUDE, MATCH, NOT_MATCH.
dayOfWeek	form	string	yes	Day of the week — MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, or SUNDAY Values: MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY.

Responses: 200 — Success · 404 — Site not found · 500 — Internal server error. Errors follow the shared conventions.

POST /rest-api/site/{siteId}/targeting/device-format/create.do

Request examples

Create site device format targeting.

Parameter	In	Type	Required	Description
siteId	path	integer	yes	Unique numeric ID of the site
rule	form	string	yes	Targeting rule type — INCLUDE for whitelist or EXCLUDE for blacklist Values: INCLUDE, EXCLUDE, MATCH, NOT_MATCH.
deviceFormat	form	string	yes	Device form factor to target (e.g. DESKTOP, MOBILE, TABLET, CONNECTED_TV) Values: DESKTOP, TABLET, MOBILE, SMART_TV.

Responses: 200 — Success · 404 — Site not found · 500 — Internal server error. Errors follow the shared conventions.

GET /rest-api/site/{siteId}/targeting/device-format/values.do

Request examples

Get device format targeting values for site.

Parameter	In	Type	Required	Description
siteId	path	integer	yes	Unique numeric ID of the site

Responses: 200 — Success · 404 — Site not found · 500 — Internal server error. Errors follow the shared conventions.

POST /rest-api/site/{siteId}/targeting/device-ram/create.do

Request examples

Create site device RAM targeting.

Parameter	In	Type	Required	Description
siteId	path	integer	yes	Unique numeric ID of the site
rule	form	string	yes	Targeting rule type — INCLUDE for whitelist or EXCLUDE for blacklist Values: INCLUDE, EXCLUDE, MATCH, NOT_MATCH.
deviceRam	form	integer	yes	Device RAM size in megabytes to target
relation	form	string	no	Comparison relation — LOWER, GREATER, LOWER_EQUAL, GREATER_EQUAL or EQUAL; omitted, it is GREATER_EQUAL Values: LOWER, GREATER, LOWER_EQUAL, GREATER_EQUAL, EQUAL.

Responses: 200 — Success · 404 — Site not found · 500 — Internal server error. Errors follow the shared conventions.

POST /rest-api/site/{siteId}/targeting/device-release-year/create.do

Request examples

Create site device release year targeting.

Parameter	In	Type	Required	Description
siteId	path	integer	yes	Unique numeric ID of the site
rule	form	string	yes	Targeting rule type — INCLUDE for whitelist or EXCLUDE for blacklist Values: INCLUDE, EXCLUDE, MATCH, NOT_MATCH.
deviceReleaseYear	form	integer	yes	Device release year to target (e.g. 2020, 2023)
relation	form	string	no	Comparison relation — LOWER, GREATER, LOWER_EQUAL, GREATER_EQUAL or EQUAL; omitted, it is GREATER_EQUAL Values: LOWER, GREATER, LOWER_EQUAL, GREATER_EQUAL, EQUAL.

Responses: 200 — Success · 404 — Site not found · 500 — Internal server error. Errors follow the shared conventions.

POST /rest-api/site/{siteId}/targeting/device-vendor/create.do

Request examples

Create site device vendor targeting.

Parameter	In	Type	Required	Description
siteId	path	integer	yes	Unique numeric ID of the site
rule	form	string	yes	Targeting rule type — INCLUDE for whitelist or EXCLUDE for blacklist Values: INCLUDE, EXCLUDE, MATCH, NOT_MATCH.
deviceVendor	form	string	yes	Device manufacturer/vendor to target (e.g. APPLE, SAMSUNG, HUAWEI) Values: SAMSUNG, APPLE, XIAOMI, VIVO, OPPO, HONOR, TECNO, INFINIX, HUAWEI, REALME, MOTOROLA, ONEPLUS, ITEL, NOKIA, ZTE, AMAZON, PHILIPS, WIKO, LENOVO, NUBIA, HISENSE, CHANGHONG, KIVI, MEIZU, TCL … (+14 more, 39 total).

Responses: 200 — Success · 404 — Site not found · 500 — Internal server error. Errors follow the shared conventions.

GET /rest-api/site/{siteId}/targeting/device-vendor/values.do

Request examples

Get device vendor targeting values for site.

Parameter	In	Type	Required	Description
siteId	path	integer	yes	Unique numeric ID of the site

Responses: 200 — Success · 404 — Site not found · 500 — Internal server error. Errors follow the shared conventions.

POST /rest-api/site/{siteId}/targeting/disable.do

Request examples

Disable site targeting.

Parameter	In	Type	Required	Description
siteId	path	integer	yes	Unique numeric ID of the site

Responses: 200 — Success · 404 — Site not found · 500 — Internal server error. Errors follow the shared conventions.

POST /rest-api/site/{siteId}/targeting/dmp/create.do

Request examples

Create site DMP targeting.

Parameter	In	Type	Required	Description
siteId	path	integer	yes	Unique numeric ID of the site
rule	form	string	yes	Targeting rule type Values: INCLUDE, EXCLUDE, MATCH, NOT_MATCH.
dmp	form	string	yes	DMP — enum name or numeric ID Values: FIRST_PARTY, DTSCOUT, AIDATA, LOTAME, SITEMATH, MEDIAQUARK, JOTTIX.
dmpSegmentId	form	integer	yes	ID of a segment of that DMP

Responses: 200 — Success · 404 — Site not found · 500 — Internal server error. Errors follow the shared conventions.

POST /rest-api/site/{siteId}/targeting/domain/create.do

Request examples

Create site domain targeting.

Parameter	In	Type	Required	Description
siteId	path	integer	yes	Unique numeric ID of the site
rule	form	string	yes	Targeting rule type — INCLUDE for whitelist or EXCLUDE for blacklist Values: INCLUDE, EXCLUDE, MATCH, NOT_MATCH.
domain	form	string	yes	Referrer domain to target (e.g. example.com)

Responses: 200 — Success · 404 — Site not found · 500 — Internal server error. Errors follow the shared conventions.

POST /rest-api/site/{siteId}/targeting/enable.do

Request examples

Enable site targeting.

Parameter	In	Type	Required	Description
siteId	path	integer	yes	Unique numeric ID of the site

Responses: 200 — Success · 404 — Site not found · 500 — Internal server error. Errors follow the shared conventions.

POST /rest-api/site/{siteId}/targeting/hardware-rank/create.do

Request examples

Create site hardware rank targeting.

Parameter	In	Type	Required	Description
siteId	path	integer	yes	Unique numeric ID of the site
rule	form	string	yes	Targeting rule type — INCLUDE for whitelist or EXCLUDE for blacklist Values: INCLUDE, EXCLUDE, MATCH, NOT_MATCH.
hardwareRank	form	integer	yes	Device hardware quality rank score to target
relation	form	string	no	Comparison relation — LOWER, GREATER, LOWER_EQUAL, GREATER_EQUAL or EQUAL; omitted, it is LOWER_EQUAL Values: LOWER, GREATER, LOWER_EQUAL, GREATER_EQUAL, EQUAL.

Responses: 200 — Success · 404 — Site not found · 500 — Internal server error. Errors follow the shared conventions.

POST /rest-api/site/{siteId}/targeting/incognito-mode/create.do

Request examples

Create site incognito mode targeting.

Parameter	In	Type	Required	Description
siteId	path	integer	yes	Unique numeric ID of the site
rule	form	string	yes	Targeting rule type — INCLUDE to target incognito traffic or EXCLUDE to block it Values: INCLUDE, EXCLUDE, MATCH, NOT_MATCH.

Responses: 200 — Success · 404 — Site not found · 500 — Internal server error. Errors follow the shared conventions.

POST /rest-api/site/{siteId}/targeting/ip-range/create.do

Request examples

Create site IP range targeting.

Parameter	In	Type	Required	Description
siteId	path	integer	yes	Unique numeric ID of the site
rule	form	string	yes	Targeting rule type — INCLUDE for whitelist or EXCLUDE for blacklist Values: INCLUDE, EXCLUDE, MATCH, NOT_MATCH.
ipFrom	form	string	yes	Start IP address of the range (IPv4 or IPv6, e.g. 194.222.012.001)
ipTo	form	string	yes	End IP address of the range (IPv4 or IPv6, must be >= ipFrom)

Responses: 200 — Success · 404 — Site not found · 500 — Internal server error. Errors follow the shared conventions.

POST /rest-api/site/{siteId}/targeting/is-web-app/create.do

Request examples

Create site web app targeting.

Parameter	In	Type	Required	Description
siteId	path	integer	yes	Unique numeric ID of the site
rule	form	string	yes	Targeting rule type — INCLUDE to target web app traffic or EXCLUDE to block it Values: INCLUDE, EXCLUDE, MATCH, NOT_MATCH.

Responses: 200 — Success · 404 — Site not found · 500 — Internal server error. Errors follow the shared conventions.

POST /rest-api/site/{siteId}/targeting/language/create.do

Request examples

Create site language targeting.

Parameter	In	Type	Required	Description
siteId	path	integer	yes	Unique numeric ID of the site
rule	form	string	yes	Targeting rule type — INCLUDE for whitelist or EXCLUDE for blacklist Values: INCLUDE, EXCLUDE, MATCH, NOT_MATCH.
languageCode	form	string	yes	ISO 639-1 language code to target (e.g. en, fr, de)

Responses: 200 — Success · 404 — Site not found · 500 — Internal server error. Errors follow the shared conventions.

GET /rest-api/site/{siteId}/targeting/language/values.do

Request examples

Get language targeting values for site.

Parameter	In	Type	Required	Description
siteId	path	integer	yes	Unique numeric ID of the site

Responses: 200 — Success · 404 — Site not found · 500 — Internal server error. Errors follow the shared conventions.

POST /rest-api/site/{siteId}/targeting/location/create.do

Request examples

Create site location targeting.

Parameter	In	Type	Required	Description
siteId	path	integer	yes	Unique numeric ID of the site
rule	form	string	yes	Targeting rule type — INCLUDE for whitelist or EXCLUDE for blacklist Values: INCLUDE, EXCLUDE, MATCH, NOT_MATCH.
countryCode	form	string	yes	ISO alpha-2 country code (e.g. US, GB, DE)
regionName	form	string	no	Region name within the country (optional, for region-level targeting)
cityName	form	string	no	City name within the region (optional, requires regionName to be set)

Responses: 200 — Success · 404 — Site not found · 500 — Internal server error. Errors follow the shared conventions.

POST /rest-api/site/{siteId}/targeting/mobile-carrier/create.do

Request examples

Create site mobile carrier targeting.

Parameter	In	Type	Required	Description
siteId	path	integer	yes	Unique numeric ID of the site
rule	form	string	yes	Targeting rule type — INCLUDE for whitelist or EXCLUDE for blacklist Values: INCLUDE, EXCLUDE, MATCH, NOT_MATCH.
mobileCarriers	form	array<string>	no	Mobile carrier names, spelled exactly as GET /rest-api/targeting/mobile-carrier/bycountry/values.do lists them; an unknown name answers 400

Responses: 200 — Success · 404 — Site not found · 500 — Internal server error. Errors follow the shared conventions.

GET /rest-api/site/{siteId}/targeting/mobile-carrier/values.do

Request examples

Get mobile carrier targeting values for site.

Parameter	In	Type	Required	Description
siteId	path	integer	yes	Unique numeric ID of the site

Responses: 200 — Success · 404 — Site not found · 500 — Internal server error. Errors follow the shared conventions.

GET /rest-api/site/{siteId}/targeting/operating-system/{osName}/versions.do

Request examples

Get OS version values for site.

Parameter	In	Type	Required	Description
siteId	path	integer	yes	Unique numeric ID of the site
osName	path	string	yes	Operating system. Accepts enum name or integer ID for backward compatibility Values: UNSPECIFIED, WINDOWS, LINUX, MAC_OS_X, IOS, IPADOS, ANDROID, SYMBIAN, J2ME, BLACKBERRY, XMB, BADA, PALM_OS, SOLARIS, MEEGO, CHROME_OS, FREE_BSD, WINDOWS_PHONE, SAMSUNG_TIZEN, HISENSE_VIDAA, LG_WEB_OS, ROKU_TV_OS, AMAZON_FIRE_TV, APPLE_TV, ANDROID_TV.

Responses: 200 — Success · 404 — Site not found · 500 — Internal server error. Errors follow the shared conventions.

POST /rest-api/site/{siteId}/targeting/operating-system/create.do

Request examples

Create site OS targeting.

Parameter	In	Type	Required	Description
siteId	path	integer	yes	Unique numeric ID of the site
rule	form	string	yes	Targeting rule — INCLUDE for whitelist or EXCLUDE for blacklist Values: INCLUDE, EXCLUDE, MATCH, NOT_MATCH.
operatingSystem	form	string	yes	Operating system to target (e.g., WINDOWS, MACOS, LINUX, ANDROID, IOS) Values: UNSPECIFIED, WINDOWS, LINUX, MAC_OS_X, IOS, IPADOS, ANDROID, SYMBIAN, J2ME, BLACKBERRY, XMB, BADA, PALM_OS, SOLARIS, MEEGO, CHROME_OS, FREE_BSD, WINDOWS_PHONE, SAMSUNG_TIZEN, HISENSE_VIDAA, LG_WEB_OS, ROKU_TV_OS, AMAZON_FIRE_TV, APPLE_TV, ANDROID_TV.
version	form	string	no	Optional OS version: a version value from the OS versions endpoint (for example 16.-1 for iOS 16.x.x) or its title. An unknown version, or a version on an OS without versions, answers 400 with the valid versions
relation	form	string	no	Version comparison relation — LOWER, GREATER, LOWER_EQUAL, GREATER_EQUAL or EQUAL. Required when version is sent (a version without it answers 400); ignored without version Values: LOWER, GREATER, LOWER_EQUAL, GREATER_EQUAL, EQUAL.

Responses: 200 — Success · 404 — Site not found · 500 — Internal server error. Errors follow the shared conventions.

GET /rest-api/site/{siteId}/targeting/operating-system/values.do

Request examples

Get OS targeting values for site.

Parameter	In	Type	Required	Description
siteId	path	integer	yes	Unique numeric ID of the site

Responses: 200 — Success · 404 — Site not found · 500 — Internal server error. Errors follow the shared conventions.

POST /rest-api/site/{siteId}/targeting/operation-between-rule-types.do

Request examples

Set how site targeting rule types combine.

Parameter	In	Type	Required	Description
siteId	path	integer	yes	Unique numeric ID of the site
operator	form	string	yes	AND — every rule type must match; OR — any one rule type is enough Values: AND, OR.

Responses: 200 — Success — the response carries the saved operationBetweenRuleTypes · 404 — Site not found · 500 — Internal server error. Errors follow the shared conventions.

POST /rest-api/site/{siteId}/targeting/platform-rank/create.do

Request examples

Create site platform rank targeting.

Parameter	In	Type	Required	Description
siteId	path	integer	yes	Unique numeric ID of the site
rule	form	string	yes	Targeting rule type — INCLUDE for whitelist or EXCLUDE for blacklist Values: INCLUDE, EXCLUDE, MATCH, NOT_MATCH.
platformRank	form	integer	yes	Platform popularity rank score to target
relation	form	string	no	Comparison relation — LOWER, GREATER, LOWER_EQUAL, GREATER_EQUAL or EQUAL; omitted, it is LOWER_EQUAL Values: LOWER, GREATER, LOWER_EQUAL, GREATER_EQUAL, EQUAL.

Responses: 200 — Success · 404 — Site not found · 500 — Internal server error. Errors follow the shared conventions.

POST /rest-api/site/{siteId}/targeting/preset-app-package/create.do

Request examples

Create site preset app package targeting.

Parameter	In	Type	Required	Description
siteId	path	integer	yes	Unique numeric ID of the site
rule	form	string	yes	Targeting rule type — INCLUDE for whitelist or EXCLUDE for blacklist Values: INCLUDE, EXCLUDE, MATCH, NOT_MATCH.
appPackageGroupId	form	integer	yes	Unique numeric ID of the preset application package group

Responses: 200 — Success · 404 — Site not found · 500 — Internal server error. Errors follow the shared conventions.

POST /rest-api/site/{siteId}/targeting/preset-domain/create.do

Request examples

Create site preset domain targeting.

Parameter	In	Type	Required	Description
siteId	path	integer	yes	Unique numeric ID of the site
rule	form	string	yes	Targeting rule type — INCLUDE for whitelist or EXCLUDE for blacklist Values: INCLUDE, EXCLUDE, MATCH, NOT_MATCH.
domainGroupId	form	integer	yes	Unique numeric ID of the preset domain group

Responses: 200 — Success · 404 — Site or domain group not found · 500 — Internal server error. Errors follow the shared conventions.

POST /rest-api/site/{siteId}/targeting/preset-ip-ranges/create.do

Request examples

Create site preset IP ranges targeting.

Parameter	In	Type	Required	Description
siteId	path	integer	yes	Unique numeric ID of the site
rule	form	string	yes	Targeting rule type — INCLUDE for whitelist or EXCLUDE for blacklist Values: INCLUDE, EXCLUDE, MATCH, NOT_MATCH.
presetIpRangesGroupId	form	integer	no	ID of the preset IP ranges group; also accepted as ipRangesGroupId. One of the two is required
ipRangesGroupId	form	integer	no	The same preset IP ranges group ID under its other name; presetIpRangesGroupId wins when both are sent

Responses: 200 — Success · 404 — Site or IP ranges group not found · 500 — Internal server error. Errors follow the shared conventions.

POST /rest-api/site/{siteId}/targeting/price-band/create.do

Request examples

Create site price band targeting.

Parameter	In	Type	Required	Description
siteId	path	integer	yes	Unique numeric ID of the site
rule	form	string	yes	Targeting rule type — INCLUDE for whitelist or EXCLUDE for blacklist Values: INCLUDE, EXCLUDE, MATCH, NOT_MATCH.
priceBand	form	number	yes	Price band threshold value to target
relation	form	string	no	Comparison relation — LOWER, GREATER, LOWER_EQUAL, GREATER_EQUAL or EQUAL; omitted, it is LOWER_EQUAL Values: LOWER, GREATER, LOWER_EQUAL, GREATER_EQUAL, EQUAL.

Responses: 200 — Success · 404 — Site not found · 500 — Internal server error. Errors follow the shared conventions.

POST /rest-api/site/{siteId}/targeting/protocol/create.do

Request examples

Create site protocol targeting.

Parameter	In	Type	Required	Description
siteId	path	integer	yes	Unique numeric ID of the site
rule	form	string	yes	Targeting rule type — INCLUDE for whitelist or EXCLUDE for blacklist Values: INCLUDE, EXCLUDE, MATCH, NOT_MATCH.
protocol	form	string	yes	Protocol to target — HTTP or HTTPS Values: HTTP, HTTPS.

Responses: 200 — Success · 404 — Site not found · 500 — Internal server error. Errors follow the shared conventions.

POST /rest-api/site/{siteId}/targeting/proxy/create.do

Request examples

Create site proxy targeting.

Parameter	In	Type	Required	Description
siteId	path	integer	yes	Unique numeric ID of the site
rule	form	string	yes	Targeting rule type — INCLUDE for whitelist or EXCLUDE for blacklist Values: INCLUDE, EXCLUDE, MATCH, NOT_MATCH.
proxy	form	string	yes	Proxy type to target: VPN, TOR, DCH (data center / hosting), PUB (public proxy), WEB (web proxy) or SES (search engine robot) Values: VPN, TOR, DCH, PUB, WEB, SES.

Responses: 200 — Success · 404 — Site not found · 500 — Internal server error. Errors follow the shared conventions.

POST /rest-api/site/{siteId}/targeting/screen-resolution/create.do

Request examples

Create site screen resolution targeting.

Parameter	In	Type	Required	Description
siteId	path	integer	yes	Unique numeric ID of the site
rule	form	string	yes	Targeting rule type — INCLUDE for whitelist or EXCLUDE for blacklist Values: INCLUDE, EXCLUDE, MATCH, NOT_MATCH.
relation	form	string	yes	Comparison operator — LOWER, GREATER, LOWER_EQUAL, GREATER_EQUAL, or EQUAL Values: LOWER, GREATER, LOWER_EQUAL, GREATER_EQUAL, EQUAL.
screenWidth	form	integer	yes	Screen width in pixels to target
screenHeight	form	integer	yes	Screen height in pixels to target

Responses: 200 — Success · 404 — Site not found · 500 — Internal server error. Errors follow the shared conventions.

GET /rest-api/site/{siteId}/targeting/screen-resolution/values.do

Request examples

Get screen resolution targeting values for site.

Parameter	In	Type	Required	Description
siteId	path	integer	yes	Unique numeric ID of the site

Responses: 200 — Success · 404 — Site not found · 500 — Internal server error. Errors follow the shared conventions.

POST /rest-api/site/{siteId}/targeting/time-range/create.do

Request examples

Create site time range targeting.

Parameter	In	Type	Required	Description
siteId	path	integer	yes	Unique numeric ID of the site
rule	form	string	yes	Targeting rule type — INCLUDE for whitelist or EXCLUDE for blacklist Values: INCLUDE, EXCLUDE, MATCH, NOT_MATCH.
timeFrom	form	string	yes	Start time in 24-hour format hh:MM (e.g. 09:00)
timeTo	form	string	yes	End time in 24-hour format hh:MM (e.g. 18:30)
clientLocalTime	form	boolean	no	If true, check time in visitor’s local timezone; otherwise use UTC (defaults to false)

Responses: 200 — Success · 404 — Site not found · 500 — Internal server error. Errors follow the shared conventions.

POST /rest-api/site/{siteId}/targeting/traffic-risk-score/create.do

Request examples

Create site traffic risk score targeting.

Parameter	In	Type	Required	Description
siteId	path	integer	yes	Unique numeric ID of the site
rule	form	string	yes	Targeting rule type — INCLUDE for whitelist or EXCLUDE for blacklist Values: INCLUDE, EXCLUDE, MATCH, NOT_MATCH.
riskLevel	form	string	yes	Traffic fraud risk level threshold. Accepts enum name or integer ID for backward compatibility Values: NOT_SCORED, LOW, LIKELY, HIGH, VERY_HIGH, CERTAIN.
relation	form	string	no	Comparison relation — LOWER, GREATER, LOWER_EQUAL, GREATER_EQUAL or EQUAL; omitted, it is GREATER_EQUAL Values: LOWER, GREATER, LOWER_EQUAL, GREATER_EQUAL, EQUAL.
riskCategory	form	array<string>	no	Array of risk categories for brand safety targeting. Accepts enum names (e.g. HIGH_RISK_IP), camelCase names (e.g. highRiskIP), or integer IDs Values: HIGH_RISK_IP, HIGH_RISK_APP, APP_SPOOFING, DISPLAY_IMPRESSION_FRAUD, DEVICE_ID_STUFFING, DEFASED_APP, VIDEO_IMPRESSION_FRAUD, HIGH_RISK_DOMAIN, IAB_CRAWLER, DATACENTER, DISPLAY_CLICK_FRAUD, LOCATION_OBFUSCATION, HIJACKED_SESSION, COOKIE_STUFFING, DATACENTER_PROXY, PUBLISHER_FRAUD, IDIO_BOTS, TOR, AUTO_RELOADER, CLICK_FARM, BLANK_USER_AGENT, PHISHING, DOORWAY_SITE, IAB_DUMMY_BOT, FAST_CLICKER.

Responses: 200 — Success · 404 — Site not found · 500 — Internal server error. Errors follow the shared conventions.

POST /rest-api/site/{siteId}/targeting/traffic-source/create.do

Request examples

Create site traffic source targeting.

Parameter	In	Type	Required	Description
siteId	path	integer	yes	Unique numeric ID of the site
rule	form	string	yes	Targeting rule type — INCLUDE for whitelist or EXCLUDE for blacklist Values: INCLUDE, EXCLUDE, MATCH, NOT_MATCH.
trafficSource	form	string	yes	Traffic source to target Values: HEADER_BIDDING.

Responses: 200 — Success · 404 — Site not found · 500 — Internal server error. Errors follow the shared conventions.

GET /rest-api/site/{siteId}/targeting/traffic-source/values.do

Request examples

Get traffic source values.

Parameter	In	Type	Required	Description
siteId	path	integer	yes	Unique numeric ID of the site

Responses: 200 — Success · 404 — Not found — resource does not exist. Errors follow the shared conventions.

GET /rest-api/site/{siteId}/targeting/types.do

Request examples

Get available targeting types for site.

Parameter	In	Type	Required	Description
siteId	path	integer	yes	Unique numeric ID of the site

Responses: 200 — Success · 404 — Site not found · 500 — Internal server error. Errors follow the shared conventions.

POST /rest-api/site/{siteId}/targeting/wifi-traffic/create.do

Request examples

Create site WiFi traffic targeting.

Parameter	In	Type	Required	Description
siteId	path	integer	yes	Unique numeric ID of the site
rule	form	string	yes	Targeting rule type — INCLUDE to target WiFi traffic or EXCLUDE to block it Values: INCLUDE, EXCLUDE, MATCH, NOT_MATCH.

Responses: 200 — Success · 404 — Site not found · 500 — Internal server error. Errors follow the shared conventions.

GET /rest-api/site/{siteId}/targetings.do

Request examples

Get site targeting rules.

Parameter	In	Type	Required	Description
siteId	path	integer	yes	Unique numeric ID of the site

Responses: 200 — Success · 404 — Site not found · 500 — Internal server error. Errors follow the shared conventions.

DELETE /rest-api/site/{siteId}/targetings.do

Request examples

Delete all site targeting rules.

Parameter	In	Type	Required	Description
siteId	path	integer	yes	Unique numeric ID of the site
targetType	form	string	no	Optional targeting type filter — only rules of this type are deleted Values: COUNTRY, BROWSER_COUNTRY, LOCATION, LANGUAGE, MOBILE_CARRIER, TIME_RANGE, DAY_OF_WEEK, DATE_TIME, OPERATING_SYSTEM, BROWSER, DEVICE_FORMAT, DEVICE_VENDOR, RESOLUTION, PROTOCOL, WIFI_TRAFFIC, IS_WEB_APP, INCOGNITO_MODE, DEVICE_RELEASE_YEAR, DEVICE_RAM, BROWSER_RANK, HARDWARE_RANK, PLATFORM_RANK, PRICE_BAND, DOMAIN, CHANNEL … (+18 more, 43 total).
rule	form	string	no	Optional rule filter — only INCLUDE or only EXCLUDE rules are deleted Values: INCLUDE, EXCLUDE, MATCH, NOT_MATCH.

Responses: 200 — Success — the response carries the deleted count · 404 — Site not found · 500 — Internal server error. Errors follow the shared conventions.

Related

• REST API overview — authentication and conventions
• API endpoint reference by tag
• Targeting, capping and limits via API