Get placement limits

Reference

GET https://YOUR-NETWORK-DOMAIN/rest-api/placement/{placementId}/limits.do

Reads the delivery limits of a placement: every request, impression, click and conversion cap and counter (daily, weekly, monthly, total) the caller may see, startDate/endDate (yyyy-MM-dd-HH-mm, GMT+0), evenPacing, useLocalTime and limitsSet=true. A placement without limits answers {placementId, limitsSet:false}. A cap whose INVENTORY_*_LIMIT permission the role lacks is left out and listed, with that permission, in fieldsHiddenByPermission. Requires a share on the placement's site and the MANAGE_INVENTORY_LIMIT permission (READONLY is enough).

Path Params

placementId integer required

ID of the placement

3001

Query Params

timezoneOffset integer

The caller's offset from UTC in minutes (east positive). With the limit on local time, startDate/endDate are answered in that offset, as the console shows them; omitted, they are in UTC

120

Responses

200

Placement limits, or {placementId, limitsSet:false} when none are set

400

Bad request — invalid or missing parameters

401

Authentication error

403

No share on the site or no MANAGE_INVENTORY_LIMIT permission

404

Placement not found

Language

cURL Request

curl --request GET \
  --url 'https://YOUR-NETWORK-DOMAIN/rest-api/placement/3001/limits.do?timezoneOffset=120' \
  --header 'X-Api-Key: YOUR_API_KEY'

Python Request

import requests

response = requests.request("GET", "https://YOUR-NETWORK-DOMAIN/rest-api/placement/3001/limits.do?timezoneOffset=120", headers={"X-Api-Key": "YOUR_API_KEY"})
print(response.json())

Node Request

const response = await fetch('https://YOUR-NETWORK-DOMAIN/rest-api/placement/3001/limits.do?timezoneOffset=120', {
  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/placement/3001/limits.do?timezoneOffset=120"))
    .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/placement/3001/limits.do?timezoneOffset=120");
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/placement/3001/limits.do?timezoneOffset=120", 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/placement/3001/limits.do?timezoneOffset=120");
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/placement/3001/limits.do?timezoneOffset=120")
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