Request

GET /campaign/getAllCampaigns

Response

JSON Fields	Type	Description
messages	Object Array	An array of any error messages.
messages[].level	String	Error level.
messages[].code	String	Error code.
messages[].message	String	Error message.
entity	Object Array	An array of campaign objects.
entity[].id	Number	Campaign ID.
entity[].advertiserId	Number	Advertiser ID associated with the campaign.
entity[].name	String	Campaign name.
entity[].domain	String	The advertiser domain for the campaign (e.g. viant.com).
entity[].maxBudget	Number	Total lifetime budget for the campaign in USD.
entity[].dailyBudget	Number	Maximum daily spend in USD.
entity[].dailyFrequencyCap Note: The name of this field is misleading since it is not necessarily "daily". The name of this field remains unchanged for backwards compatibility and will be updated on the next major version.	Number	The maximum number of impressions a user is exposed to per frequency cap time period duration. See frequencyCapDuration and frequencyCapTimePeriod.
entity[].frequencyCapDuration	Number	The number of given frequencyCapTimePeriod.
entity[].frequencyCapTimePeriod	String	"MINUTE", "HOUR", or "DAY"
entity[].startDate	Number	Start date as Unix time in milliseconds.
entity[].endDate	Number	End date as Unix time in milliseconds.
entity[].iabCategory	String Array	IAB category codes associated with the campaign (e.g., "IAB8-6").
entity[].markupRate	Number	Percentage markup (e.g., 0.10 for 10%).
entity[].lifetimeImpressionCap	Number	Lifetime impression cap.
entity[].dailyImpressionCap	Number	Daily impression cap.
entity[].lifetimeClickCap	Number	Lifetime click cap.
entity[].dailyClickCap	Number	Daily click cap.
entity[].ioNumber	String	IO Number.
entity[].externalCampaignId	String	External (Client) campaign ID.
entity[].channelGroup	String	Deprecated. Generally displays as "MOBILE_COMPUTER_CTV".
entity[].minBidMultiplier	Number	Minimum bid multiplier.
entity[].maxBidMultiplier	Number	Maximum bid multiplier.
entity[].hasFlights	Boolean	True if this campaign has campaign flights (read-only).
entity[].flights	Object Array	Array of Campaign Flights.
entity[].autoAdvertising	Boolean	Flag indicating if Viant AI is enabled for this campaign.
entity[].pacingMode	String	One of: ASAP SPEND_EVENLY
entity[].intradayFrontloadPct	Number	Increases hourly budget to spend more at the beginning of the day.
entity[].objective	String	One of: AWARENESS ENGAGEMENT CONVERSION

Example

Request

curl -u <user>:<password> https://sandbox-api.viant.com/v1/campaign/getAllCampaigns

Response

{
  "messages": [],
  "entity": [
    {
      "id": 90,
      "advertiserId": 456,
      "name": "Big Box Branding",
      "domain": "bigbox.com",
      "maxBudget": 10000.50,
      "dailyBudget": 1000,
      "dailyFrequencyCap": 10,
      "frequencyCapDuration": 3,
      "frequencyCapTimePeriod": "HOUR",
      "startDate": 1464739200000,
      "endDate": 1483228800000,
      "markupRate": 0.10,
	"lifetimeImpressionCap": 10000,
      "dailyImpressionCap": 100,
      "lifetimeClickCap": 10,
      "dailyClickCap": 5,
      "iabCategory": [
        "IAB22",
        "IAB18"
      ],
      "ioNumber": "12345",
      "externalCampaignId": "12345",
      "channelGroup": "MOBILE_COMPUTER_CTV",
      "minBidMultiplier": null,
      "maxBidMultiplier": null,
      "autoAdvertising": false,
      "pacingMode": "SPEND_EVENLY",
      "intradayFrontloadPct": 0.0
      "hasFlights": true,
      "flights": [
        {
          "id": 10054,
          "status": "COMPLETED",
          "budgetType": "AUTO_BUDGET",
          "dailyBudget": 1000,
          "dailyFrontload": 0.0,
          "maxBudget": 10000.0,
          "remainingBudget": null,
          "dailyImpCap": null,
          "lifetimeImpCap": null,
          "startDate": 1464739200000,
          "endDate": 1483228800000
        }
      ]
    },
    {
      "id": 91,
      "advertiserId": 654,
      "name": "Next Big Messenger",
      "domain": "mymessenger.com",
      "maxBudget": 20000,
      "dailyBudget": 1000,
      "dailyFrequencyCap": null,
      "frequencyCapDuration": null,
      "frequencyCapTimePeriod": null,
      "startDate": 1462060800000,
      "endDate": 1464652800000,
      "markupRate": 0.20,
"lifetimeImpressionCap": 10000,
      "dailyImpressionCap": 100,
      "lifetimeClickCap": 10,
      "dailyClickCap": 5,
      "iabCategory": [
        "IAB19"
      ],
      "ioNumber": "23456",
      "externalCampaignId": "23456",
      "channelGroup": "MOBILE_COMPUTER_CTV",
      "minBidMultiplier": null,
      "maxBidMultiplier": null,
      "autoAdvertising": false,
      "pacingMode": "ASAP",
      "intradayFrontloadPct": 0.0,
      "hasFlights": false,
      "flights": []
    }
  ]
}