List zones for site

Returns all non-deleted zones belonging to the specified site.

Reference

GET https://YOUR-NETWORK-DOMAIN/rest-api/sites/{siteId}/zones.do

Returns all non-deleted zones belonging to the specified site. Requires ALL or SHARED level VIEW permission on INVENTORY. If the site does not exist or is deleted, an empty list is returned. Each zone in the response includes its ID and name. Zones are ordered by id and can be narrowed by any on/off setting or relation flag (filter[...]) and trimmed to the fields named in fields.

Path Params

siteId integer required

Unique numeric ID of the parent site

5001

Query Params

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

Zones returned successfully

400

Bad request — invalid or missing parameters

401

Authentication error

403

Forbidden — insufficient permissions

404

Not found — resource does not exist

Language

cURL Request

curl --request GET \
  --url 'https://YOUR-NETWORK-DOMAIN/rest-api/sites/5001/zones.do?fields=id%2Cname%2Cactive&filter=%7B%22hasLimits%22%3A%20%22true%22%7D' \
  --header 'X-Api-Key: YOUR_API_KEY'

Python Request

import requests

response = requests.request("GET", "https://YOUR-NETWORK-DOMAIN/rest-api/sites/5001/zones.do?fields=id%2Cname%2Cactive&filter=%7B%22hasLimits%22%3A%20%22true%22%7D", headers={"X-Api-Key": "YOUR_API_KEY"})
print(response.json())

Node Request

const response = await fetch('https://YOUR-NETWORK-DOMAIN/rest-api/sites/5001/zones.do?fields=id%2Cname%2Cactive&filter=%7B%22hasLimits%22%3A%20%22true%22%7D', {
  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/sites/5001/zones.do?fields=id%2Cname%2Cactive&filter=%7B%22hasLimits%22%3A%20%22true%22%7D"))
    .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/sites/5001/zones.do?fields=id%2Cname%2Cactive&filter=%7B%22hasLimits%22%3A%20%22true%22%7D");
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/sites/5001/zones.do?fields=id%2Cname%2Cactive&filter=%7B%22hasLimits%22%3A%20%22true%22%7D", 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/sites/5001/zones.do?fields=id%2Cname%2Cactive&filter=%7B%22hasLimits%22%3A%20%22true%22%7D");
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/sites/5001/zones.do?fields=id%2Cname%2Cactive&filter=%7B%22hasLimits%22%3A%20%22true%22%7D")
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