Decision API

post

https://e-YOUR-NETWORKID.adzerk.net/api/v2

The Decision API enables you to make ad requests without using ad code. By posting to a RESTful endpoint, Kevel's ad engine will return decision data and creative contents that can be used to serve ads in your application.You'll want to set the Content-Type in the header as application/json. The API will also accept text/plain to support applications that cannot change the content type

Path Params

networkId

int32

required

Your account (network) ID

Body Params

placements

array of objects

required

Every request must contain one or more placements. Each placement represents a "slot" in which an ad may be served. Click the '+' below to view the placement object fields.

placements*

user

object

Object containing the UserKey used for UserDB targeting.

keywords

array of strings

Keywords for Keyword Targeting. Such as "keywords": ["foo", "bar", "baz"]

keywords

url

string

The current page URL

referrer

string

The referrer URL

string

The IP address. Required for Geo-Targeting

includePricingData

boolean

Defaults to false

If true, return pricing data for the decision in the response. Defaults to false

includeRelevancyData

boolean

Defaults to false

See the relevancy score documentation for more information

notrack

boolean

Defaults to false

Deprecated: If true, only return ads that are set to honor Do Not Track. Defaults to false

enableBotFiltering

boolean

Defaults to false

If making a client-side request, set to true. Defaults to false to ensure a server isn't seen as a bot. See here for more info

enableUserDBIP

boolean

If true, override the IP address of the request with the IP address supplied on the UserKey. If no IP address is found on the UserKey, this will fall back to the IP address on the request. Requires UserDB.

consent

object

Object that sets the data consent preferences. For example, "consent": {"gdpr": true} sets GDPR consent for tracking in the European Union. (This defaults to false.) Other consent settings are available in the GDPR settings documentation.

deviceID

string

RTB requests only - sets an Identifier for Advertisers (IFA or IDFA)

parallel

boolean

Defaults to false

If true, processes the placements in parallel. Has no advantage except for RTB and header bidding requests. Does not work with companion ads.

intendedLatitude

float

(BETA) Latitude to use for Distance Targeting. Range: [-90, 90]. Contact Kevel support to get started

intendedLongitude

float

(BETA) Longitude to use for Distance Targeting. Range: [-180, 180]. Contact Kevel support to get started

radius

float

(BETA) Radius of the user if using user-specified radius with Distance Targeting. Range: [0.01, 100]. Contact Kevel support to get started

time

string

Parameter utilized when you want to configure day/time parting.

searchTerm

string

See Search Term Targeting.

block

object

Prevents specific advertisers, campaigns, creatives, or flights from being served in the response.

Response

200200