Why List Advertisers?

If you would like to review the current advertisers that are part of a campaign, or make changes to the campaign, having a list of all current advertisers for the campaign is very useful. The List Advertisers API endpoint enables you return a JSON object for all of your advertisers. If you would like to use the Explorer, simply use your API key.

API Syntax

When using the List Advertisers 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/advertiser

Where:

• GET - the type of API request being made.
• https://api.kevel.co - the URL for the request.
• v1 - the API version.
• advertiser - the API endpoint being called.

Response Schema

200
object

page
integer

Defaults to 0

items
array of objects

items
object

Id
integer

Defaults to 0

Title
string

IsActive
boolean

Defaults to true

IsDeleted
boolean

Defaults to true

PlacementLimit
string

FreqCap
integer

Defaults to 0

FreqCapDuration
integer

Defaults to 0

FreqCapType
integer

Defaults to 0

CapType
integer

Defaults to 0

DailyCapAmount
integer

Defaults to 0

LifetimeCapAmount
integer

Defaults to 0

Example Request

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

Example Response

{
  "page": 1,
  "items": [
    {
      "Id": 123,
      "Title": "Nike",
      "IsActive": true,
      "IsDeleted": false,
      "PlacementLimit": null,
      "FreqCap": 2,
      "FreqCapDuration": 10,
      "FreqCapType": 1,
      "CapType": 4,
      "DailyCapAmount": 5000,
      "LifetimeCapAmount": 50000
    }
  ]
}