Search campaigns

Performs an advanced search over campaigns using filter parameters submitted as a JSON request body.

Reference

POST https://YOUR-NETWORK-DOMAIN/rest-api/search/campaigns.do

Performs an advanced search over campaigns using filter parameters submitted as a JSON request body. Supports pagination (limit/page), sorting (sortBy/sortDir), active status filtering, name filtering, filtering by campaign ids (ids), and targeting parameter filters. The response optionally includes targeting, pricing, and limits data for each campaign depending on 'showTargeting', 'showPricing', and 'showLimits' flags (subject to the caller's permissions for MANAGE_DEMAND_TARGETING, MANAGE_CAPPING_AND_LIMITATIONS, and MANAGE_PRICING respectively). Users with CAMPAIGNS SHARE permission see all campaigns; otherwise only campaigns shared with the authenticated user are returned. Response is a JSON object with 'data' array and 'total' count.

Body

A JSON body. An example, built from the field definitions:

{
  "limit": "25",
  "page": "0",
  "sortBy": "1",
  "sortDir": "desc"
}

Responses

200

JSON object with 'data' array of campaign objects (each containing baseEntity, target, limit, pricing) and 'total' count

400

Bad request — invalid or missing parameters

401

Authentication error - invalid hash, timestamp, or username

403

Forbidden — insufficient permissions

Language

cURL Request

curl --request POST \
  --url 'https://YOUR-NETWORK-DOMAIN/rest-api/search/campaigns.do' \
  --header 'X-Api-Key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
  "limit": "25",
  "page": "0",
  "sortBy": "1",
  "sortDir": "desc"
}'

Python Request

import requests

response = requests.request("POST", "https://YOUR-NETWORK-DOMAIN/rest-api/search/campaigns.do", headers={"X-Api-Key": "YOUR_API_KEY"}, json={
    "limit": "25",
    "page": "0",
    "sortBy": "1",
    "sortDir": "desc"
})
print(response.json())

Node Request

const response = await fetch('https://YOUR-NETWORK-DOMAIN/rest-api/search/campaigns.do', {
  method: 'POST',
  headers: { 'X-Api-Key': 'YOUR_API_KEY', 'Content-Type': 'application/json' },
  body: JSON.stringify({
    "limit": "25",
    "page": "0",
    "sortBy": "1",
    "sortDir": "desc"
  }),
});

console.log(await response.json());

Java Request

HttpClient client = HttpClient.newHttpClient();

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://YOUR-NETWORK-DOMAIN/rest-api/search/campaigns.do"))
    .header("X-Api-Key", "YOUR_API_KEY")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.ofString("{\"limit\":\"25\",\"page\":\"0\",\"sortBy\":\"1\",\"sortDir\":\"desc\"}"))
    .build();

HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

C# Request

using var client = new HttpClient();

var request = new HttpRequestMessage(new HttpMethod("POST"), "https://YOUR-NETWORK-DOMAIN/rest-api/search/campaigns.do");
request.Headers.Add("X-Api-Key", "YOUR_API_KEY");
request.Content = new StringContent("{\"limit\":\"25\",\"page\":\"0\",\"sortBy\":\"1\",\"sortDir\":\"desc\"}", Encoding.UTF8, "application/json");

var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());

Go Request

package main

import (
	"fmt"
	"io"
	"net/http"
	"strings"
)

func main() {
	req, _ := http.NewRequest("POST", "https://YOUR-NETWORK-DOMAIN/rest-api/search/campaigns.do", strings.NewReader(`{"limit":"25","page":"0","sortBy":"1","sortDir":"desc"}`))
	req.Header.Set("X-Api-Key", "YOUR_API_KEY")
	req.Header.Set("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()

	out, _ := io.ReadAll(res.Body)
	fmt.Println(string(out))
}

PHP Request

<?php
$ch = curl_init("https://YOUR-NETWORK-DOMAIN/rest-api/search/campaigns.do");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, ["X-Api-Key: YOUR_API_KEY", "Content-Type: application/json"]);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{"limit":"25","page":"0","sortBy":"1","sortDir":"desc"}');

echo curl_exec($ch);
curl_close($ch);

Ruby Request

require 'net/http'
require 'json'

uri = URI("https://YOUR-NETWORK-DOMAIN/rest-api/search/campaigns.do")
request = Net::HTTP::Post.new(uri)
request['X-Api-Key'] = 'YOUR_API_KEY'
request['Content-Type'] = 'application/json'
request.body = "{\"limit\":\"25\",\"page\":\"0\",\"sortBy\":\"1\",\"sortDir\":\"desc\"}"

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }
puts response.body