/

Browse the help center

List all campaigns

Returns all non-deleted campaigns accessible by the authenticated user.

Reference

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

Returns all non-deleted campaigns accessible by the authenticated user. Users with the SHARE permission on CAMPAIGNS see all campaigns in the system; otherwise, only campaigns linked to the user's advertiser shares are returned. Results can be narrowed by the active flag, an advertiser, label names and any on/off setting (filter[...]), ordered by id and paged with offset and limit, and trimmed to the fields named in fields; a labels filter matches any of its names, and one naming no existing label returns an empty list. Use the selfServRequest flag to receive a simplified self-serve response format. Each campaign's 'status' array holds UI status tokens computed from traffic statistics, which are not the on/off switch — that is the 'active' field: status-active = switched on AND served traffic in the last ~6 hours; status-not-active = switched off OR no traffic in the last ~6 hours, so active=true together with status-not-active is normal for an idle, not-yet-started or newly created campaign; status-finished (added alongside) = the campaign's delivery limits have ended it — end date passed, total limit reached or an action limit reached. 'hasTraffic' is the same ~6-hour traffic flag on its own. Traffic data is refreshed hourly. A deleted campaign has an empty array.

Query Params

selfServRequest boolean

When true, returns a simplified self-serve response format instead of the full campaign details

false

active boolean

When set, returns only active (true) or only inactive (false) campaigns; omit to return both

true

labels array<string>

Label names to filter by; a campaign carrying any of them is returned

premium

advertiserId integer

Advertiser ID to restrict results to a single advertiser

1001

offset integer

Pagination offset over campaigns ordered by id (zero-based)

0

limit integer

Maximum number of campaigns to return; omit for all

100

fields array<string>

Return only these fields of each entity, comma-separated; id is always kept. A requested field no returned row carries is named in the X-Ignored-Fields response header

id,name,active

filter object

Keep only entities matching every key, e.g. filter[cpaOptimization]=true&filter[hasLimit]=true. Keys are the entity's on/off settings (active, enableTargeting, cpaOptimization, alwaysRedirect, ...) and a has<Relation> flag for each setting kept in rows of its own (hasLimit, hasPricing, hasFrequencyCapping, hasTrackingCode, hasPriceAdjustmentRules, hasLabels, hasBanners, ...), true when the relation holds a row; hasCapping, hasLimits and hasTargetingRules group the relations of their kind. An unknown key is a 400 that lists every valid key for the list.

{"hasLimits": "true"}

Responses

200

List of campaigns

400

Bad request — invalid or missing parameters

401

Authentication error

403

Forbidden — insufficient permissions

Language

cURL Request

curl --request GET \
  --url 'https://YOUR-NETWORK-DOMAIN/rest-api/campaigns.do?advertiserId=1001&active=true&selfServRequest=false&labels=premium' \
  --header 'X-Api-Key: YOUR_API_KEY'

Python Request

import requests

response = requests.request("GET", "https://YOUR-NETWORK-DOMAIN/rest-api/campaigns.do?advertiserId=1001&active=true&selfServRequest=false&labels=premium", headers={"X-Api-Key": "YOUR_API_KEY"})
print(response.json())

Node Request

const response = await fetch('https://YOUR-NETWORK-DOMAIN/rest-api/campaigns.do?advertiserId=1001&active=true&selfServRequest=false&labels=premium', {
  method: 'GET',
  headers: { 'X-Api-Key': 'YOUR_API_KEY' },
});

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

Java Request

HttpClient client = HttpClient.newHttpClient();

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://YOUR-NETWORK-DOMAIN/rest-api/campaigns.do?advertiserId=1001&active=true&selfServRequest=false&labels=premium"))
    .header("X-Api-Key", "YOUR_API_KEY")
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .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("GET"), "https://YOUR-NETWORK-DOMAIN/rest-api/campaigns.do?advertiserId=1001&active=true&selfServRequest=false&labels=premium");
request.Headers.Add("X-Api-Key", "YOUR_API_KEY");

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

Go Request

package main

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

func main() {
	req, _ := http.NewRequest("GET", "https://YOUR-NETWORK-DOMAIN/rest-api/campaigns.do?advertiserId=1001&active=true&selfServRequest=false&labels=premium", nil)
	req.Header.Set("X-Api-Key", "YOUR_API_KEY")

	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/campaigns.do?advertiserId=1001&active=true&selfServRequest=false&labels=premium");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "GET");
curl_setopt($ch, CURLOPT_HTTPHEADER, ["X-Api-Key: YOUR_API_KEY"]);

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

Ruby Request

require 'net/http'
require 'json'

uri = URI("https://YOUR-NETWORK-DOMAIN/rest-api/campaigns.do?advertiserId=1001&active=true&selfServRequest=false&labels=premium")
request = Net::HTTP::Get.new(uri)
request['X-Api-Key'] = 'YOUR_API_KEY'

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