Get Flight

This returns the parameters for a specific flight

get/v1/flight/{FlightID}

Request

  • Base URL
    https://api.kevel.co
  • URL
    https://api.kevel.co/v1/flight/{FlightID}
  • Auth
    API key in header X-Adzerk-ApiKey

Path parameters

FlightIDinteger required

This is the ID of the Flight

Query parameters

excludeAdsboolean

If true, the endpoint returns only the flight metadata without ad objects

Response

200

Idinteger
NoEndDateunknown
Priceinteger
OptionTypeinteger
Impressionsinteger
IsUnlimitedboolean
IsNoDuplicatesboolean
DuplicateModeinteger
IsFullSpeedboolean
Keywordsstring
UserAgentKeywordsunknown
Namestring
WeightOverrideunknown
IsFreqCapunknown
IsCompanionboolean
CampaignIdinteger
PriorityIdinteger
IsDeletedboolean
IsActiveboolean
CustomTargetingstring
GoalTypeinteger
RateTypeinteger
IsECPMOptimizedunknown
ECPMOptimizePeriodunknown
ECPMMultiplierunknown
FloorECPMunknown
CeilingECPMnumber
DefaultECPMnumber
ECPMBurnInImpressionsinteger
EffectiveCPMOverridenumber
DatePartingStartTimeunknown
DatePartingEndTimeunknown
IsSundayboolean
IsMondayboolean
IsTuesdayboolean
IsWednesdayboolean
IsThursdayboolean
IsFridayboolean
IsSaturdayboolean
FreqCapinteger
FreqCapDurationinteger
FreqCapTypeinteger
CapTypeinteger
DailyCapAmountunknown
LifetimeCapAmountunknown
DeliveryStatusinteger
CustomFieldsJsonstring
BehavioralTargetingunknown
IsTargetingOptimizationunknown
TargetingOptimizationTypeunknown
TargetingOptimizationTargetTypeunknown
TargetingOptimizationTargetunknown
TargetingOptimizationBurnInunknown
TargetingOptimizationCanMissunknown
IsArchivedunknown
CanPassbackboolean
PassbackSortOrderinteger
StartDateISOstring

Example response

{
  "Id": 12345,
  "OptionType": 1,
  "Impressions": 100,
  "IsNoDuplicates": true,
  "DuplicateMode": 4,
  "Name": "The Great API Flight",
  "CampaignId": 12345,
  "PriorityId": 1234,
  "IsActive": true,
  "GeoTargeting": [
    {
      "LocationId": 1234567,
      "CountryCode": "US",
      "Region": "NC",
      "MetroCode": 560,
      "City": "Durham",
      "CityGeonameId": 4464368
    }
  ],
  "SiteZoneTargeting": [
    {
      "Id": 123456,
      "FlightId": 12345,
      "SiteId": 12345,
      "IsExclude": true
    }
  ],
  "GoalType": 2,
  "RateType": 1,
  "CeilingECPM": 0.35,
  "DefaultECPM": 0.28,
  "ECPMBurnInImpressions": 1000,
  "IsSunday": true,
  "IsMonday": true,
  "IsTuesday": true,
  "IsWednesday": true,
  "IsThursday": true,
  "IsFriday": true,
  "IsSaturday": true,
  "CapType": 1,
  "DeliveryStatus": 1,
  "CustomFieldsJson": "{\"SKU\":\"\"}",
  "CreativeMaps": [
    {
      "Id": 12345,
      "CampaignId": 12345,
      "FlightId": 12345,
      "Impressions": 100,
      "DistributionType": 1,
      "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",
        "ImageLink": "httpss://static.adzerk.net/Advertisers/99b3fbfdd2e8491295c9d0d5dc4d5a2f.gif"
      }
    }
  ],
  "CanPassback": true,
  "PassbackSortOrder": 1,
  "StartDateISO": "2015-06-08T00:00:00.0000000"
}

Changes

No recorded changes to this operation across all 1 revision of this API.