List all sites

Returns all non-deleted publisher sites belonging to the authenticated user's account.

Reference

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

Returns all non-deleted publisher sites belonging to the authenticated user's account. Requires ALL or SHARED level VIEW permission on INVENTORY. When using SHARED level, a share of any type must exist between the requester and each site. Results can be filtered by publishing category IDs, and by any on/off setting or relation flag (filter[...]); they are ordered by id, paged with offset and limit, and trimmed to the fields named in fields. Additional site details (URL, email, etc.) can be included via the basicInfo and basicInfoIds parameters.

Query Params

publishingCategories array<integer>

IDs of publishing categories to filter sites by

10

basicInfo boolean

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

true

basicInfoIds array<string>

Comma-separated site IDs for which to include additional basic info

5001,5002

offset integer

Pagination offset over sites ordered by id (zero-based)

0

limit integer

Maximum number of sites to return; omit for all

100

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

Site list 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.do?publishingCategories=10&basicInfo=true&basicInfoIds=5001%2C5002' \
  --header 'X-Api-Key: YOUR_API_KEY'

Python Request

import requests

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

Node Request

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