/v2/advertisers/{advertiserId}/campaigns/search

POST

https://<pcm-domain>/v2/advertisers/{advertiserId}/campaigns/search

Retrieves filtered and paginated campaigns of the given advertiser based on user's access.

Rules:

The values array for the MODIFIED_AFTER filter must take exactly one value in the format yyyy-MM-dd'T'HH:mm
.SSS'Z' e.g. {"field":"MODIFIED_AFTER", "values":["2025-02-05T12:34
.000Z"]}.

Notes:

sortType defaults to ascending if not passed.

Path Parameters

advertiserIdinteger<int32>required
Format
int32

Body Parameters

bodyCampaignSearchRequestrequired
- filtersFilterValuesCampaignFilterField[]
  - fieldstring<STATUS | CAMPAIGN | MODIFIED_AFTER>
    Allowed
    STATUSCAMPAIGNMODIFIED_AFTER
  - valuesobject[]
- pageinteger<int32>required
  Format
  int32
  Minimum
  0
  Maximum
  1000
- limitinteger<int32>required
  Format
  int32
  Minimum
  1
  Maximum
  10000
- sortTypestring<ASC | DESC>
  Allowed
  ASCDESC
- orderBystring<CAMPAIGN | STATUS | MARKET | BUDGET | BUDGET_SPENT | SPEND_VELOCITY | START_DATE | END_DATE>required
  Allowed
  CAMPAIGNSTATUSMARKETBUDGETBUDGET_SPENTSPEND_VELOCITYSTART_DATEEND_DATE

Responses

200OK

ListResponseCampaignResponseVoid
- detailedCampaignResponse[]
  - idinteger<int32>
    Format
    int32
  - marketIdinteger<int32>
    Format
    int32
  - namestring
  - statusstring<ADVERTISED | ARCHIVED | PAUSED>
    Allowed
    ADVERTISEDARCHIVEDPAUSED
  - budgetnumber
  - budgetSpentnumber
  - budgetUnallocatednumber
    Description
    The budget which is not used yet by the ad groups belonging to this campaign.
  - deletableboolean
  - spendVelocitynumber<double>
    Description
    The pacing of the campaign measures budget efficiency over time, where a value of 1.0 reflects ideal spend considering temporal progress of the campaign, less than 1.0 underspending, and more than 1.0 overspending. The value is not set for campaign creation/update or whenever there is at least one ad group without end date.
    Format
    double
  - startDatestring<date-time>
    Description
    The earliest start date of all ad groups belonging to this campaign.
    Format
    date-time
  - endDatestring<date-time>
    Description
    The latest end date of all ad groups belonging to this campaign. Value is not set whenever there is at least one ad group without end date.
    Format
    date-time
  - modifiedAtstring<date-time>
    Format
    date-time
  - advertisedboolean
- aggregatedAggregatedVoid
  - countinteger<int64>
    Format
    int64
  - metrics

401Unauthorized

403Forbidden

404Not Found

ExceptionResponse
- messagesstring[]

422Unprocessable Entity

ExceptionResponse
- messagesstring[]

curl

curl --request POST \
     --url https://<pcm-domain>/v2/advertisers/{advertiserId}/campaigns/search \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '{
     "page": 0,
     "limit": 0,
     "orderBy": ""
     }'

javascript

var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");

var raw = JSON.stringify({
   "page": 0,
   "limit": 0,
   "orderBy": ""
});

var requestOptions = {
   method: 'POST',
   headers: myHeaders,
   body: raw,
   redirect: 'follow'
};

fetch("https://<pcm-domain>/v2/advertisers/{advertiserId}/campaigns/search", requestOptions)
   .then(response => response.text())
   .then(result => console.log(result))
   .catch(error => console.log('error', error));

ruby

require "uri"
require "json"
require "net/http"

url = URI("https://<pcm-domain>/v2/advertisers/{advertiserId}/campaigns/search")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Post.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"
request.body = JSON.dump({
   "page": 0,
   "limit": 0,
   "orderBy": ""
})

response = https.request(request)
puts response.read_body

python

import requests
import json

url = "https://<pcm-domain>/v2/advertisers/{advertiserId}/campaigns/search"

payload = json.dumps({
   "page": 0,
   "limit": 0,
   "orderBy": ""
})
headers = {
   'accept': 'application/json',
   'content-type': 'application/json'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

200

// OK
{
  "detailed": [
    {
      "id": "",
      "marketId": "",
      "name": "",
      "status": "",
      "budget": 0,
      "budgetSpent": 0,
      "budgetUnallocated": 0,
      "deletable": false,
      "spendVelocity": "",
      "startDate": "",
      "endDate": "",
      "modifiedAt": "",
      "advertised": false
    }
  ],
  "aggregated": {
    "count": "",
    "metrics": ""
  }
}

401

// Unauthorized

403

// Forbidden

404

// Not Found
{
  "messages": [
    ""
  ]
}

422

// Unprocessable Entity
{
  "messages": [
    ""
  ]
}