v1

latestOpenAPI 3.1.02026-07-2616636641.7 KB

Get Campaign

get/v1/campaign/{CampaignID}

Path parameters

CampaignIDinteger required

The ID of the Campaign

Query parameters

excludeFlightsboolean

If true, returns only campaign metadata without flight objects. Defaults to false

Response

200

IsActiveboolean

{"stackTrail":"paths:/v1/campaign/{CampaignID}:get:responses:200:content:application/json:schema:properties:DontAffectParentFreqCap","oasType":"schema","type":"unknown"}

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

FreqCapTypeinteger

{"stackTrail":"paths:/v1/campaign/{CampaignID}:get:responses:200:content:application/json:schema:properties:CapType","oasType":"schema","type":"unknown"}

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

IsDeletedboolean

{"stackTrail":"paths:/v1/campaign/{CampaignID}:get:responses:200:content:application/json:schema:properties:EndDateISO","oasType":"schema","type":"unknown"}

Priceinteger

IsArchivedboolean

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

{"stackTrail":"paths:/v1/campaign/{CampaignID}:get:responses:200:content:application/json:schema:properties:FreqCapDuration","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/v1/campaign/{CampaignID}:get:responses:200:content:application/json:schema:properties:FreqCap","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/v1/campaign/{CampaignID}:get:responses:200:content:application/json:schema:properties:SalespersonId","oasType":"schema","type":"unknown"}

AdvertiserIdinteger

Namestring

Idinteger

{"stackTrail":"paths:/v1/campaign/{CampaignID}:get:responses:200:content:application/json:schema:properties:CustomFieldsJson","oasType":"schema","type":"unknown"}

StartDateISOstring

Example response

{
  "IsArchived": true,
  "AdvertiserId": 12345,
  "Name": "Nike Q4 Campaign",
  "Id": 56789,
  "StartDateISO": "2017-03-11T00:00:00.0000000"
}