/

Browse the help center

List banners

Returns a paginated list of banners accessible to the authenticated user.

Reference

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

Returns a paginated list of banners accessible to the authenticated user. Results can be filtered by campaign, advertising categories, template IDs, approval statuses, labels, banner name, active state, placement type, creative type and any on/off setting (filter[...]); every filter narrows the result, and a list filter matches any of its values. fields trims each banner to the fields named. A labels filter naming no existing label returns an empty list. Each banner in the response includes traffic status, linkage state, and native preferences (for native banners). Use the selfServRequest flag to receive the Self-Serve response format.

Query Params

advertisingCategories array<integer>

IDs of advertising categories to filter by

5

templateIds array<integer>

Template IDs to filter by

100

approvalStatuses array<string>

Approval statuses to filter by (e.g., NEW, PENDING, APPROVED, REJECTED)

APPROVED

labels array<string>

Label names to filter by

premium

campaignId integer

Campaign ID to restrict results to a single campaign

2001

offset integer

Pagination offset (0-based)

0

limit integer

Maximum number of banners to return

25

selfServRequest boolean

If true, returns the Self-Serve response format

false

bannerName string

Part of the banner name to search for, case-insensitive

summer

active boolean

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

true

placementTypes array<string>

Placement types the banners are made for, e.g. VIDEO_PLACEMENT; a banner matching any of them is returned

VIDEO_PLACEMENT

bannerTypes array<string>

Creative types to filter by, e.g. VAST_2_0_TAG_URL; a banner matching any of them is returned

TEMPLATE

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 banners

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/banners.do?campaignId=2001&active=true&advertisingCategories=5&templateIds=100' \
  --header 'X-Api-Key: YOUR_API_KEY'

Python Request

import requests

response = requests.request("GET", "https://YOUR-NETWORK-DOMAIN/rest-api/banners.do?campaignId=2001&active=true&advertisingCategories=5&templateIds=100", headers={"X-Api-Key": "YOUR_API_KEY"})
print(response.json())

Node Request

const response = await fetch('https://YOUR-NETWORK-DOMAIN/rest-api/banners.do?campaignId=2001&active=true&advertisingCategories=5&templateIds=100', {
  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/banners.do?campaignId=2001&active=true&advertisingCategories=5&templateIds=100"))
    .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/banners.do?campaignId=2001&active=true&advertisingCategories=5&templateIds=100");
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/banners.do?campaignId=2001&active=true&advertisingCategories=5&templateIds=100", 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/banners.do?campaignId=2001&active=true&advertisingCategories=5&templateIds=100");
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/banners.do?campaignId=2001&active=true&advertisingCategories=5&templateIds=100")
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