Get banner limits

Retrieves the current impression, click, conversion, budget and opportunity limits configured for the specified banner.

Reference

GET https://YOUR-NETWORK-DOMAIN/rest-api/banner/{bannerId}/limits.do

Retrieves the current impression, click, conversion, budget and opportunity limits configured for the specified banner. The response includes every cap the set/update endpoints accept, with its current counter — daily, weekly, monthly and total — the date range (startDate/endDate, GMT+0), evenPacing, useLocalTime and limitsSet=true. A banner without limits answers {bannerId, limitsSet:false}. Requires UPDATE permission on the banner's parent advertiser and the MANAGE_CAPPING_AND_LIMITATIONS user permission. Each cap and counter (budget, opportunities, impressions, clicks, conversions — every period) is shown only when the role holds its limit permission (e.g. WEEKLY_CLICKS_LIMIT, MONTHLY_BUDGET) enabled or readonly, like the console Limits card.

Path Params

bannerId integer required

Unique numeric identifier of the banner whose limits should be retrieved

42

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

Banner limits, or {bannerId, limitsSet:false} when none are set

400

Bad request — invalid or missing parameters

401

Authentication error

403

Not enough permissions

404

Banner not found

Language

cURL Request

curl --request GET \
  --url 'https://YOUR-NETWORK-DOMAIN/rest-api/banner/42/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/banner/42/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/banner/42/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/banner/42/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/banner/42/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/banner/42/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/banner/42/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/banner/42/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