Get network settings

Returns the network settings that shape the caller's own figures and requests.

Reference

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

Returns the network settings that shape the caller's own figures and requests. 'currency' is the currency every price, bid, floor, budget and revenue figure is in (always USD). 'reportingTimeZone' is the zone General reports and the dashboard bucket their days and hours in; only the Advanced report takes its own zone (usersTimeZoneId). 'newEntities' holds the defaults a create applies when the request leaves them out: 'active' for advertisers, campaigns and banners, 'siteApprovalStatus' for sites (APPROVED, PENDING or REJECTED) and 'piggybackActive' for piggybacks. 'analyticsApi' holds the analytics REST quota: 'dailyRequestLimit' reports a day per user, 'requestsUsedToday' of them already spent by the caller, and 'recordsPerRequestLimit', the most rows one report may ask for (also the default when 'limit' is omitted). 'creativeFileLimits' holds the largest image and video file, in bytes, a banner upload accepts. Any logged-in user may read these; 'siteApprovalStatus' is left out for a user who may not create sites and 'analyticsApi' for a user with no report type. The rest of System Preferences stays admin-only.

Responses

200

{success, currency, reportingTimeZone:{id, utcOffset}, newEntities:{active, siteApprovalStatus, piggybackActive}, analyticsApi:{dailyRequestLimit, requestsUsedToday, recordsPerRequestLimit}, creativeFileLimits:{maxImageFileBytes, maxVideoFileBytes}}

400

Bad request — invalid or missing parameters

401

Unauthorized — authentication error

403

Forbidden — insufficient permissions

Language

cURL Request

curl --request GET \
  --url 'https://YOUR-NETWORK-DOMAIN/rest-api/network/settings.do' \
  --header 'X-Api-Key: YOUR_API_KEY'

Python Request

import requests

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

Node Request

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