List advertisers with campaigns and banners tree

Returns all non-deleted advertisers with their nested campaigns and banners as a JSON array, forming a complete inventory tree.

Reference

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

Returns all non-deleted advertisers with their nested campaigns and banners as a JSON array, forming a complete inventory tree. Each advertiser object includes standard advertiser fields (id, name, active, category, description) plus a 'campaigns' array, where each campaign contains its own fields and a nested 'banners' array. Deleted campaigns and banners are excluded from the tree. Requires VIEW permission on CAMPAIGNS at ALL level (returns all advertisers) or SHARED level (returns only shared advertisers). Results can be filtered by advertising category IDs. This endpoint is useful for building a full advertiser-campaign-banner hierarchy view in a single request; on a large network read it in pages with start and limit (advertisers ordered by id).

Query Params

advertisingCategories array<integer>

Optional array of advertising category IDs to filter the results. Only advertisers belonging to at least one of the specified categories will be returned. Pass multiple values as repeated query parameters, e.g. advertisingCategories=1&advertisingCategories=5.

5

start integer

Paging: skip this many advertisers (ordered by id). Default 0

0

limit integer

Paging: at most this many advertisers, each with all its campaigns and banners. Omitted — every advertiser. A page shorter than limit is the last one

20

Responses

200

Array of advertiser objects with nested campaigns and banners

400

Bad request — invalid or missing parameters

401

Unauthorized — authentication failed or missing credentials

403

Insufficient permissions

Language

cURL Request

curl --request GET \
  --url 'https://YOUR-NETWORK-DOMAIN/rest-api/advertisers-tree.do?advertisingCategories=5&start=0&limit=20' \
  --header 'X-Api-Key: YOUR_API_KEY'

Python Request

import requests

response = requests.request("GET", "https://YOUR-NETWORK-DOMAIN/rest-api/advertisers-tree.do?advertisingCategories=5&start=0&limit=20", headers={"X-Api-Key": "YOUR_API_KEY"})
print(response.json())

Node Request

const response = await fetch('https://YOUR-NETWORK-DOMAIN/rest-api/advertisers-tree.do?advertisingCategories=5&start=0&limit=20', {
  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/advertisers-tree.do?advertisingCategories=5&start=0&limit=20"))
    .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/advertisers-tree.do?advertisingCategories=5&start=0&limit=20");
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/advertisers-tree.do?advertisingCategories=5&start=0&limit=20", 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/advertisers-tree.do?advertisingCategories=5&start=0&limit=20");
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/advertisers-tree.do?advertisingCategories=5&start=0&limit=20")
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