List campaigns for advertiser

Returns all campaigns belonging to the specified advertiser as a JSON array.

Reference

GET https://YOUR-NETWORK-DOMAIN/rest-api/advertiser/{advertiserId}/campaigns.do

Returns all campaigns belonging to the specified advertiser as a JSON array. Each campaign object includes detailed fields: id, name, active, advertiserId, priority, weight, exchangeRate, ctrOptimization, cpaOptimization, ecpmOptimization, enableActions, enableTargeting, creation_time, description, bannerIds, bannersCount, labels, autoLinkCategories, status, hasTraffic, and direct-deal fields when applicable. The authenticated user must have VIEW permission on CAMPAIGNS (via share or ALL level) for the advertiser. 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.

Path Params

advertiserId integer required

Unique numeric ID of the advertiser whose campaigns to list

1001

Responses

200

Array of campaign objects

400

Bad request — invalid or missing parameters

401

Unauthorized — authentication failed or missing credentials

403

Insufficient permissions

404

Advertiser not found or deleted

Language

cURL Request

curl --request GET \
  --url 'https://YOUR-NETWORK-DOMAIN/rest-api/advertiser/1001/campaigns.do' \
  --header 'X-Api-Key: YOUR_API_KEY'

Python Request

import requests

response = requests.request("GET", "https://YOUR-NETWORK-DOMAIN/rest-api/advertiser/1001/campaigns.do", headers={"X-Api-Key": "YOUR_API_KEY"})
print(response.json())

Node Request

const response = await fetch('https://YOUR-NETWORK-DOMAIN/rest-api/advertiser/1001/campaigns.do', {
  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/advertiser/1001/campaigns.do"))
    .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/advertiser/1001/campaigns.do");
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/advertiser/1001/campaigns.do", 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/advertiser/1001/campaigns.do");
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/advertiser/1001/campaigns.do")
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