Get site by ID

Returns the full details of a single publisher site by its numeric ID.

Reference

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

Returns the full details of a single publisher site by its numeric ID. The site must not be deleted and the requester must have VIEW permission on the site through ALL or SHARED level INVENTORY permissions. SSP sites are excluded from access when the user is SSP-filtered. Set basicInfo to true to include additional details like URL, email, and contact information. Every field sites/update writes is returned at the top level under the same name (active, url, bundle, inventoryType, impressionsByMonth, visitorsByMonth, schainSellerId, categoryId, ...; an unset one is left out); a field the console shows only with a permission the caller lacks is left out and listed, with that permission, in fieldsHiddenByPermission. approvalStatus is the network's approval of the site (APPROVED, PENDING or REJECTED); a site that is not APPROVED serves no ads. The response also carries additionalFieldValues: every custom field the network defines for this entity type, keyed by field id, each with its name and this entity's value (null when unset) - the values of /rest-api/additional-fields/{entityType}/{entityId}.

Path Params

siteId integer required

Unique numeric ID of the site

5001

Query Params

basicInfo boolean

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

true

Responses

200

Site returned successfully

400

Bad request — invalid or missing parameters

401

Authentication error

403

Access forbidden for this site

404

Site not found or deleted

Language

cURL Request

curl --request GET \
  --url 'https://YOUR-NETWORK-DOMAIN/rest-api/sites/5001.do?basicInfo=true' \
  --header 'X-Api-Key: YOUR_API_KEY'

Python Request

import requests

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

Node Request

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