List sites with zones and placements

Returns all non-deleted sites for the authenticated user along with their nested zones and placements as a hierarchical tree structure.

Reference

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

Returns all non-deleted sites for the authenticated user along with their nested zones and placements as a hierarchical tree structure. Requires ALL or SHARED level VIEW permission on INVENTORY. Results can be filtered by publishing category IDs. Each site in the response includes its child zones, and each zone includes its child placements. On a large network read it in pages with start and limit (sites ordered by id).

Query Params

basicInfo boolean

If true, includes additional site details such as URL, email, and contact info

true

publishingCategories array<integer>

IDs of publishing categories to filter sites by

10

start integer

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

0

limit integer

Paging: at most this many sites, each with all its zones and placements. Omitted — every site. A page shorter than limit is the last one

20

Responses

200

Site tree 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/sites-tree.do?basicInfo=true&publishingCategories=10&start=0' \
  --header 'X-Api-Key: YOUR_API_KEY'

Python Request

import requests

response = requests.request("GET", "https://YOUR-NETWORK-DOMAIN/rest-api/sites-tree.do?basicInfo=true&publishingCategories=10&start=0", headers={"X-Api-Key": "YOUR_API_KEY"})
print(response.json())

Node Request

const response = await fetch('https://YOUR-NETWORK-DOMAIN/rest-api/sites-tree.do?basicInfo=true&publishingCategories=10&start=0', {
  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-tree.do?basicInfo=true&publishingCategories=10&start=0"))
    .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-tree.do?basicInfo=true&publishingCategories=10&start=0");
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-tree.do?basicInfo=true&publishingCategories=10&start=0", 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-tree.do?basicInfo=true&publishingCategories=10&start=0");
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-tree.do?basicInfo=true&publishingCategories=10&start=0")
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