Get Priorities for a Channel

Why Get Priorities for a Channel?

Sometimes, you may wish to retrieve the assigned priorities for a specific channel. The Inventory Management API enables you to return a list of all priorities for a channel via the Get Priorities for a Channel API endpoint.

When you make a call to this endpoint, a list of all priorities for the channel specified (using ChannelID) will be returned in the response.

API Syntax

When using the Get Priorities for a Channel API endpoint it is important to understand the syntax required to make the request. Because the Kevel API is a RESTful API, there is a specific request format that must be followed to ensure the endpoint can process the request. The format is:

GET https://api.kevel.co/v1/channel/{ChannelID}/priorities

Where:

GET - the type of API request being made.
http://api.kevel.co - the URL for the request.
v1 - the API version.
channel - the API endpoint being called.
ChannelID - the ID associated with the channel.
priorities - the priorities assigned to the channel

Response Properties

Property	Description
`Weight` (integer)	The ranking of a priority within a channel. Priorities with lower numbers will be given the first chance to serve. Range is from 1 to 100.
`SelectionAlgorithm` (integer)	Determines how ads in a priority are chosen by the ad serving engine. Can only be set at the time of priority creation and cannot be changed. Values: `(0) Lottery (also represented as null)` `(1) Auction` `(2) Ad Chain Ordered` `(3) Ad Chain Optimized` `(4) Lottery With Outbid`

ChannelID

int32

required

The ID of the Channel

``200 200

json

Updated 10 months ago

ShellJavaScriptRuby


xxxxxxxxxx

curl -X GET -H "X-Adzerk-ApiKey:$ADZERK_API_KEY" "https://api.kevel.co/v1/channel/12345/priorities"


xxxxxxxxxx

[
  
  {
    "IsAdChainOptimized": false,
    "IsSecondPricing": null,
    "IsAdChain": false,
    "PassbackTimeout": null,
    "ChannelId": 12345,
    "RelevancyScoreConfig": null,
    "IsAdChainOrdered": false,
    "IsDeleted": false,
    "IsKeywordOptimized": null,
    "Weight": 1,
    "SerializeRelevancyScoreConfigJSON": null,
    "FloorPrice": null,
    "IsAuction": false,
    "RelevancyScoreConfigJSON": null,
    "Name": "Sponsorship",
    "SelectionAlgorithm": 0,
    "Id": 123456
  },...
  ]

Updated10 months ago