v1

latestOpenAPI 3.1.02026-07-2616636641.7 KB

Flight Filtering

get/v1/fast/flight

Query parameters

isActiveboolean

Only return flights where IsActive is [true/false]. Default is true.

isArchivedboolean

Only return flights where IsArchived is [true/false]. Default is false.

beforeStartDatestring

Only return flights where StartDate is before the provided date. Format: YYYY-MM-DD HH:MM:SS; HH:MM:SS optional

afterStartDatestring

Only return flights where StartDate is after the provided date. Format: YYYY-MM-DD HH:MM:SS; HH:MM:SS optional

beforeEndDatestring

Only return flights where EndDate is before the provided date. Format: YYYY-MM-DD HH:MM:SS; HH:MM:SS optional

afterEndDatestring

Only return flights where EndDate is after the provided date. Format: YYYY-MM-DD HH:MM:SS; HH:MM:SS optional

noEndDateboolean

Only return flights where EndDate is null

namestring

Only return flights where Name is an exact match of the query.

nameContainsstring

Only return flights where the given string is a substring of the Name. No wildcard characters are supported.

Response

200

LastModifiedDatestring
CustomFieldsJsonstring
StartDatestring
PriorityIdinteger
IsDeletedboolean
Idinteger
IsNoDuplicatesboolean
{"stackTrail":"paths:/v1/fast/flight:get:responses:200:content:application/json:schema:properties:IsArchived","oasType":"schema","type":"unknown"}
RateTypeinteger
FreqCapinteger
IsCompanionboolean
CanPassbackboolean
CapTypeinteger
Priceinteger
IsActiveboolean
FreqCapTypeinteger
CustomTargetingstring
IsTrackingConversionsboolean
FreqCapDurationinteger
{"stackTrail":"paths:/v1/fast/flight:get:responses:200:content:application/json:schema:properties:PassbackSortOrder","oasType":"schema","type":"unknown"}
GoalTypeinteger
{"stackTrail":"paths:/v1/fast/flight:get:responses:200:content:application/json:schema:properties:DailyCapAmount","oasType":"schema","type":"unknown"}
Namestring
{"stackTrail":"paths:/v1/fast/flight:get:responses:200:content:application/json:schema:properties:LifetimeCapAmount","oasType":"schema","type":"unknown"}
AdvertiserIdinteger
Keywordsstring
{"stackTrail":"paths:/v1/fast/flight:get:responses:200:content:application/json:schema:properties:EndDate","oasType":"schema","type":"unknown"}
AdIdsinteger[]
Impressionsinteger
CampaignIdinteger

Example response

{
  "LastModifiedDate": "2016-12-08T21:34:32Z",
  "CustomFieldsJson": "{\"Currency\":\"USD: US Dollars\"}",
  "StartDate": "2016-12-08T00:00:00Z",
  "PriorityId": 1234,
  "Id": 1234567,
  "RateType": 1,
  "CapType": 1,
  "IsActive": true,
  "GoalType": 2,
  "Name": "There's a Flight",
  "AdvertiserId": 12345,
  "AdIds": [
    1234567
  ],
  "Impressions": 100,
  "CampaignId": 123456
}