/

Browse the help center

List placements with details and filters

Reference

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

Returns summary information for the placements the user can see: ID, name, description, type, site and zone IDs and names, category, labels, ad unit size, placement key, active flag, default code, targeting settings and native preferences; video placements also carry their video ad manager settings. Placements of every type are returned — SITE_PLACEMENT, MOBILE_SITE_PLACEMENT, NON_STANDARD_SITE_PLACEMENT, VIDEO_PLACEMENT, APPLICATION_PLACEMENT, EMAIL_PLACEMENT, CLICK_THROUGH_PLACEMENT and NATIVE_PLACEMENT. size is the ad unit's title, WIDTHxHEIGHT for a placement sized without an ad unit, or - when it has no size; dimensions carries the same as {width, height, adUnitId, adUnitName}, or null. Results can be filtered by publishing categories, specific placement IDs, site ID, zone ID, placement types, active state, label names and any on/off setting (filter[...]), paged via offset and limit, and trimmed to the fields named in fields; every filter narrows the result, and a list filter matches any of its values. A labels filter naming no existing label returns an empty list.

Query Params

publishingCategories array<integer>

IDs of publishing categories to filter placements by

5

placementIds array<integer>

Specific placement IDs to retrieve

4001

zoneId integer

Zone ID to filter placements by

3001

labels array<string>

Label names to filter placements by

premium

offset integer

Pagination offset (zero-based index of the first result)

0

limit integer

Maximum number of placements to return

50

types array<string>

Placement types to filter by; a placement matching any of them is returned

VIDEO_PLACEMENT

siteId integer

Site ID to filter placements by

1001

active boolean

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

true

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

Placements summary returned successfully

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/placements/summary.do?zoneId=3001&siteId=1001&active=true&publishingCategories=5&placementIds=4001' \
  --header 'X-Api-Key: YOUR_API_KEY'

Python Request

import requests

response = requests.request("GET", "https://YOUR-NETWORK-DOMAIN/rest-api/placements/summary.do?zoneId=3001&siteId=1001&active=true&publishingCategories=5&placementIds=4001", headers={"X-Api-Key": "YOUR_API_KEY"})
print(response.json())

Node Request

const response = await fetch('https://YOUR-NETWORK-DOMAIN/rest-api/placements/summary.do?zoneId=3001&siteId=1001&active=true&publishingCategories=5&placementIds=4001', {
  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/placements/summary.do?zoneId=3001&siteId=1001&active=true&publishingCategories=5&placementIds=4001"))
    .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/placements/summary.do?zoneId=3001&siteId=1001&active=true&publishingCategories=5&placementIds=4001");
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/placements/summary.do?zoneId=3001&siteId=1001&active=true&publishingCategories=5&placementIds=4001", 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/placements/summary.do?zoneId=3001&siteId=1001&active=true&publishingCategories=5&placementIds=4001");
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/placements/summary.do?zoneId=3001&siteId=1001&active=true&publishingCategories=5&placementIds=4001")
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