Skip to main content

List Ad Campaigns

GET 

/ads/campaigns

Page through ad campaigns with their window figures, the count per status and the ROAS floor conversion campaigns are judged against. Status Live matches delivering campaigns. Requires ads.read. On a cursor page, pagination.total and totalPages are the counts the first page reported: the total is counted only on the first page, where it is cheap to wait for. The ranking is computed per request, so a cursor resumes after the last row it held by that row's sort values; a row whose figures change while you walk can move across the cursor.

Request and response fields at a glance
  • Query parameters: brandIds (array), saleChannelIds (array), startDate (string), endDate (string), adTypes (array), targetingModes (array), statuses (array), search (string), sort (string), dir (string), page (integer), limit (integer).
  • 200 response (application/json): campaigns (array, required), statusCounts (object, required), pagination (object, required), roasFloor (number, required).

Request​