Why Get Flight?

The Get Flight API call enables you to return information about a specific flight, which can be helpful if you want to review the flight before making any changes. Because a flight can impact the overall performance of a campaign, occasionally reviewing the specifics of a particular flight for a campaign may allow you to glean insights into what changes, if any, you may want to make to an existing flight for a campaign.

API Syntax

When using the Create Flight 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}

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 you want to return.

📘

Note

The table below contains additional properties that may be returned in the response.

FlightID

• Type: int32
• Required: This is the ID of the Flight

excludeAds

• Type: boolean
• If true, the endpoint returns only the flight metadata without ad objects

Response example

{
  "Id": 12345,
  "NoEndDate": null,
  "Price": 0,
  "OptionType": 1,
  "Impressions": 100,
  "IsUnlimited": false,
  "IsNoDuplicates": true,
  "DuplicateMode": 4,
  "IsFullSpeed": false,
  "Keywords": "",
  "UserAgentKeywords": null,
  "Name": "The Great API Flight",
  "WeightOverride": null,
  "IsFreqCap": null,
  "IsCompanion": false,
  "CampaignId": 12345,
  "PriorityId": 1234,
  "IsDeleted": false,
  "IsActive": true,
  "GeoTargeting": [
    {
      "LocationId": 1234567,
      "FlightId": 0,
      "CountryCode": "US",
      "Region": "NC",
      "MetroCode": 560,
      "IsExclude": null
    }
  ],
  "SiteZoneTargeting": [
    {
      "Id": 123456,
      "FlightId": 12345,
      "SiteId": 12345,
      "ZoneId": null,
      "IsExclude": true
    }
  ],
  "CustomTargeting": "",
  "GoalType": 2,
  "RateType": 1,
  "IsECPMOptimized": null,
  "ECPMOptimizePeriod": null,
  "ECPMMultiplier": null,
  "FloorECPM": null,
  "CeilingECPM": null,
  "DefaultECPM": null,
  "ECPMBurnInImpressions": null,
  "EffectiveCPMOverride": null,
  "DatePartingStartTime": null,
  "DatePartingEndTime": null,
  "IsSunday": true,
  "IsMonday": true,
  "IsTuesday": true,
  "IsWednesday": true,
  "IsThursday": true,
  "IsFriday": true,
  "IsSaturday": true,
  "FreqCap": 0,
  "FreqCapDuration": 0,
  "FreqCapType": 0,
  "CapType": 1,
  "DailyCapAmount": null,
  "LifetimeCapAmount": null,
  "DeliveryStatus": 1,
  "CustomFieldsJson": {
    "SKU": ""
  },
  "BehavioralTargeting": null,
  "CreativeMaps": [
    {
      "Id": 12345,
      "CampaignId": 12345,
      "FlightId": 12345,
      "ZoneId": 0,
      "SiteId": 0,
      "Iframe": null,
      "PublisherAccountId": 0,
      "Impressions": 100,
      "Percentage": 0,
      "DistributionType": 1,
      "IsDeleted": false,
      "IsActive": true,
      "Creative": {
        "Id": 12345,
        "Title": "The Great API Creative",
        "ImageName": "99b3fbfdd2e8491295c9d0d5dc4d5a2f.gif",
        "Url": "https://adzerk.com",
        "Body": """,
        "AdvertiserId": 12345,
        "IsActive": true,
        "AdTypeId": 5,
        "Alt": "New alt tag",
        "IsDeleted": null,
        "IsSync": null,
        "IsHTMLJS": false,
        "Metadata": null,
        "ImageLink": "httpss://static.adzerk.net/Advertisers/99b3fbfdd2e8491295c9d0d5dc4d5a2f.gif"
      },
      "CustomTargeting": "",
      "FreqCap": 0,
      "FreqCapDuration": 0,
      "FreqCapType": 0,
      "StartDate": null,
      "EndDate": null,
      "GoalType": 0,
      "Goal": null,
      "IsGoalOverride": null,
      "IsStartEndDateOverride": null,
      "ActiveKeywords": [],
      "RtbCustomFields": null
    }
  ],
  "IsTargetingOptimization": null,
  "TargetingOptimizationType": null,
  "TargetingOptimizationTargetType": null,
  "TargetingOptimizationTarget": null,
  "TargetingOptimizationBurnIn": null,
  "TargetingOptimizationCanMiss": null,
  "GeoDistanceTargeting": [],
  "IsArchived": null,
  "CanPassback": true,
  "PassbackSortOrder": 1,
  "StartDateISO": "2015-06-08T00:00:00.0000000"
}

Examples

Exclude ads (returns faster with less data)

curl -X GET \
     -H "X-Adzerk-ApiKey:$ADZERK_API_KEY" \
     "https://api.kevel.co/v1/flight/12345?excludeAds=true"