v1

latestOpenAPI 3.1.02026-07-2616636641.7 KB

Create Priority

This API call adds a new priority to a specific channel.

post/v1/priority

Request body

Namestring required

The Priority's Name

ChannelIdstring required

The Channel's ID

Weightinteger required

The priority order within the channel. 1-100, 1 is highest priority

SelectionAlgorithminteger required

Choose which selector the ad engines use to select an ad from this priority. Defaults to 0 (lottery). See below for the full list.

IsDeletedboolean

Do not use if creating a Priority. Defaults to false

FloorPricenumber float

Sets a floor price for second-price auction priority

FloorCPCnumber float

(BETA) Read only - Floor CPC if the Floor CPC feature is used on the priority. Contact Kevel support to get started

IsSecondPricingboolean

Whether flight uses second-price auction model

SecondPriceGroupBystring

Sets whether ads in a second-priced auction should not second price against the same: advertiser, campaign, flight, or ad. Default is null, which is equivalent to advertiser. Can only be set when IsSecondPricing is true

PassbackTimeoutinteger

Sets the timeout (in ms) for flights passing back in an adChain priority

RemainderPercentageinteger

Auctions and AdChain Optimized only. Refers to the percentage of impressions that ads with lower eCPMs will receive, which is used to give poor-perfoming ads a "second-chance".

Response

200

idinteger

namestring

channelIdinteger

weightinteger

isDeletedboolean

selectionAlgorithminteger

Example response

{
  "id": 12345,
  "name": "High Priority",
  "channelId": 1234,
  "weight": 10
}