This page provides an example of using the RESTful Get Campaigns endpoint with the externalCampaignId query param.

Request

GET /v1/campaign?externalCampaignId=12345

Note that the request string must be URL encoded if it contains any characters that require encoding.

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