List Ads for Flight

Why List Ads for a Flight

When you want to review a flight and determine what changes, if any, you would like to make, it is helpful to see a list of all ads associated with a particular flight so you can decide what changes to make. The List Ads for Flight API call enables you to return a list of all ads for a given flight.

📘

Note

In the response, depending on the settings of the ad, not all of these properties will be present (such as IsGoalOverride).

API Syntax

When using the Create Creative API, 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/flight/{FlightID}/creatives

Where:

• GET - the type of API request being made.
• https://api.kevel.co - the URL for the request.
• v1 - the API version.
• flight - the API endpoint being called.
• FlightID - the ID associated with the flight.
• creatives - the creatives associated with the flight.

FlightID

int32

required

The ID of the Flight

Response Structure

200

{
  "page": 1,
  "items": [
    {
      "Id": 123456,
      "CampaignId": 123456,
      "FlightId": 123456,
      "ZoneId": null,
      "SiteId": null,
      "PublisherAccountId": 0,
      "Impressions": 100,
      "Percentage": 0,
      "DistributionType": 1,
      "IsDeleted": false,
      "IsActive": true,
      "Creative": {
        "Id": 12345,
        "Title": "Adzerk Blue Creative",
        "ImageName": "",
        "Url": "https://adzerk.com",
        "Body": "",
        "AdvertiserId": 12345,
        "IsActive": true,
        "AdTypeId": 5,
        "Alt": "Adzerk - Native Ads",
        "IsDeleted": false,
        "IsSync": false,
        "IsHTMLJS": true,
        "ScriptBody": "JS or HTML content",
        "Metadata": {
          "something": true
        },
        "ImageLink": "httpss://static.adzerk.net/Advertisers/",
        "IsNoTrack": true,
        "IsNetworkAd": false
      },
      "CustomTargeting": "$keywords contains \"dean\"",
      "FreqCap": 5,
      "FreqCapDuration": 1,
      "FreqCapType": 2,
      "DontAffectParentFreqCap": true,
      "StartDate": null,
      "EndDate": null,
      "StartDateISO": "2017-01-01T00:00:00.0000000",
      "EndDateISO": "2015-12-05T00:00:00.0000000",
      "GoalType": 1,
      "Price": 1,
      "IsGoalOverride": true,
      "IsStartEndDateOverride": true,
      "ActiveKeywords": [
        "kittens",
        "cats"
      ]
    }
  ]
}

curl -X GET -H "X-Adzerk-ApiKey:<APIKEY>" "https://api.kevel.co/v1/flight/12345/creatives"