v1

latestOpenAPI 3.1.02026-07-2616636641.7 KB

Get Flight

This returns the parameters for a specific flight

get/v1/flight/{FlightID}

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

{"stackTrail":"paths:/v1/flight/{FlightID}:get:responses:200:content:application/json:schema:properties:NoEndDate","oasType":"schema","type":"unknown"}

Priceinteger

OptionTypeinteger

Impressionsinteger

IsUnlimitedboolean

IsNoDuplicatesboolean

DuplicateModeinteger

IsFullSpeedboolean

Keywordsstring

{"stackTrail":"paths:/v1/flight/{FlightID}:get:responses:200:content:application/json:schema:properties:UserAgentKeywords","oasType":"schema","type":"unknown"}

Namestring

{"stackTrail":"paths:/v1/flight/{FlightID}:get:responses:200:content:application/json:schema:properties:WeightOverride","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/v1/flight/{FlightID}:get:responses:200:content:application/json:schema:properties:IsFreqCap","oasType":"schema","type":"unknown"}

IsCompanionboolean

CampaignIdinteger

PriorityIdinteger

IsDeletedboolean

IsActiveboolean

CustomTargetingstring

GoalTypeinteger

RateTypeinteger

{"stackTrail":"paths:/v1/flight/{FlightID}:get:responses:200:content:application/json:schema:properties:IsECPMOptimized","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/v1/flight/{FlightID}:get:responses:200:content:application/json:schema:properties:ECPMOptimizePeriod","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/v1/flight/{FlightID}:get:responses:200:content:application/json:schema:properties:ECPMMultiplier","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/v1/flight/{FlightID}:get:responses:200:content:application/json:schema:properties:FloorECPM","oasType":"schema","type":"unknown"}

CeilingECPMnumber

DefaultECPMnumber

ECPMBurnInImpressionsinteger

EffectiveCPMOverridenumber

{"stackTrail":"paths:/v1/flight/{FlightID}:get:responses:200:content:application/json:schema:properties:DatePartingStartTime","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/v1/flight/{FlightID}:get:responses:200:content:application/json:schema:properties:DatePartingEndTime","oasType":"schema","type":"unknown"}

IsSundayboolean

IsMondayboolean

IsTuesdayboolean

IsWednesdayboolean

IsThursdayboolean

IsFridayboolean

IsSaturdayboolean

FreqCapinteger

FreqCapDurationinteger

FreqCapTypeinteger

CapTypeinteger

{"stackTrail":"paths:/v1/flight/{FlightID}:get:responses:200:content:application/json:schema:properties:DailyCapAmount","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/v1/flight/{FlightID}:get:responses:200:content:application/json:schema:properties:LifetimeCapAmount","oasType":"schema","type":"unknown"}

DeliveryStatusinteger

CustomFieldsJsonstring

{"stackTrail":"paths:/v1/flight/{FlightID}:get:responses:200:content:application/json:schema:properties:BehavioralTargeting","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/v1/flight/{FlightID}:get:responses:200:content:application/json:schema:properties:IsTargetingOptimization","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/v1/flight/{FlightID}:get:responses:200:content:application/json:schema:properties:TargetingOptimizationType","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/v1/flight/{FlightID}:get:responses:200:content:application/json:schema:properties:TargetingOptimizationTargetType","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/v1/flight/{FlightID}:get:responses:200:content:application/json:schema:properties:TargetingOptimizationTarget","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/v1/flight/{FlightID}:get:responses:200:content:application/json:schema:properties:TargetingOptimizationBurnIn","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/v1/flight/{FlightID}:get:responses:200:content:application/json:schema:properties:TargetingOptimizationCanMiss","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/v1/flight/{FlightID}:get:responses:200:content:application/json:schema:properties:IsArchived","oasType":"schema","type":"unknown"}

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
    }
  ],
  "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"
}