/

Browse the help center

Set site limits

Creates the site's limits if it has none (the console's Limits switch) and applies the given values.

Reference

POST https://YOUR-NETWORK-DOMAIN/rest-api/site/{siteId}/limits/set.do

Creates the site's limits if it has none (the console's Limits switch) and applies the given values. Accepts request caps (daily/weekly/monthly/totalRequestsLimit), impression, click and conversion caps for every period, startDate/endDate (yyyy-MM-dd-HH-mm or yyyy-MM-dd HH:mm, GMT+0 unless useLocalTime), removeStartDateLimit/removeEndDateLimit, evenPacing, useLocalTime and timezoneOffset (minutes east of UTC). Budget and opportunity fields do not exist on a site and answer 400. Requires UPDATE share on the site, MANAGE_INVENTORY_LIMIT, MANAGE_CAPPING_AND_LIMITATIONS when the limits have to be created, and the INVENTORY_*_LIMIT permission of every cap sent. Counters (the same names without the Limit suffix, e.g. totalImpressions) are read-only here: sent, they are listed in ignoredFields and left unchanged; the reset endpoint sets them back to zero.

Path Params

siteId integer required

ID of the site

1001

Form Params

dailyClicksLimit integer

Maximum clicks allowed per day

2000

dailyConversionsLimit integer

Maximum conversions allowed per day

500

dailyImpressionsLimit integer

Maximum impressions allowed per day

50000

dailyRequestsLimit integer

Ad requests allowed per day (0 = unlimited). Site and placement limits only

100000

endDate string

End date for the limiting period in yyyy-MM-dd-HH-mm (or yyyy-MM-dd HH:mm) format (GMT+0)

2025-12-31-23-59

evenPacing boolean

When true, distributes delivery evenly throughout the day rather than front-loading

true

monthlyClicksLimit integer

Maximum clicks allowed per month; 0 means no monthly cap. Resets the 1st of the month.

10000

monthlyConversionsLimit integer

Maximum conversions allowed per month; 0 means no monthly cap. Resets the 1st of the month.

10000

monthlyImpressionsLimit integer

Maximum impressions allowed per calendar month; 0 means no monthly cap. Resets on the 1st.

1500000

monthlyRequestsLimit integer

Ad requests allowed per calendar month (0 = unlimited). Site and placement limits only

2500000

removeEndDateLimit boolean

When true, removes the existing end date limit

true

removeStartDateLimit boolean

When true, removes the existing start date limit

true

startDate string

Start date for the limiting period in yyyy-MM-dd-HH-mm (or yyyy-MM-dd HH:mm) format (GMT+0)

2025-01-15-00-00

timezoneOffset integer

The caller's offset from UTC in minutes (east positive, e.g. 120 for UTC+2). With useLocalTime on, the startDate/endDate of this request are read in that offset and stored in UTC; dates not sent are left as stored

120

totalClicksLimit integer

Maximum total clicks allowed over the entire period

50000

totalConversionsLimit integer

Maximum total conversions allowed over the entire period

5000

totalImpressionsLimit integer

Maximum total impressions allowed over the entire period

1000000

totalRequestsLimit integer

Ad requests allowed over the limit's lifetime (0 = unlimited). Site and placement limits only

10000000

useLocalTime boolean

When true, startDate/endDate are given in the caller's local time (the console's Local Time switch); the limit read answers them in local time too when it is passed the same timezoneOffset, and in UTC otherwise. Omitted, the limit keeps its current setting

true

weeklyClicksLimit integer

Maximum clicks allowed per week; 0 means no weekly cap. Resets each ISO week (Monday).

10000

weeklyConversionsLimit integer

Maximum conversions allowed per week; 0 means no weekly cap. Resets each ISO week (Monday).

10000

weeklyImpressionsLimit integer

Maximum impressions allowed per week; 0 means no weekly cap. Resets each ISO week (Monday).

10000

weeklyRequestsLimit integer

Ad requests allowed per ISO week (0 = unlimited). Site and placement limits only

600000

Responses

200

Limits saved

400

Invalid value, or a field a site limit does not have

401

Authentication error

403

Missing share or permission; the message names the permission

404

Site not found

Language

cURL Request

curl --request POST \
  --url 'https://YOUR-NETWORK-DOMAIN/rest-api/site/1001/limits/set.do' \
  --header 'X-Api-Key: YOUR_API_KEY' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data-urlencode 'dailyClicksLimit=2000' \
  --data-urlencode 'dailyConversionsLimit=500' \
  --data-urlencode 'dailyImpressionsLimit=50000'

Python Request

import requests

response = requests.request("POST", "https://YOUR-NETWORK-DOMAIN/rest-api/site/1001/limits/set.do", headers={"X-Api-Key": "YOUR_API_KEY"}, data={"dailyClicksLimit": "2000", "dailyConversionsLimit": "500", "dailyImpressionsLimit": "50000"})
print(response.json())

Node Request

const response = await fetch('https://YOUR-NETWORK-DOMAIN/rest-api/site/1001/limits/set.do', {
  method: 'POST',
  headers: { 'X-Api-Key': 'YOUR_API_KEY', 'Content-Type': 'application/x-www-form-urlencoded' },
  body: new URLSearchParams({"dailyClicksLimit":"2000","dailyConversionsLimit":"500","dailyImpressionsLimit":"50000"}),
});

console.log(await response.json());

Java Request

HttpClient client = HttpClient.newHttpClient();

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://YOUR-NETWORK-DOMAIN/rest-api/site/1001/limits/set.do"))
    .header("X-Api-Key", "YOUR_API_KEY")
    .header("Content-Type", "application/x-www-form-urlencoded")
    .method("POST", HttpRequest.BodyPublishers.ofString("dailyClicksLimit=2000&dailyConversionsLimit=500&dailyImpressionsLimit=50000"))
    .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("POST"), "https://YOUR-NETWORK-DOMAIN/rest-api/site/1001/limits/set.do");
request.Headers.Add("X-Api-Key", "YOUR_API_KEY");
request.Content = new FormUrlEncodedContent(new Dictionary<string, string> { ["dailyClicksLimit"] = "2000", ["dailyConversionsLimit"] = "500", ["dailyImpressionsLimit"] = "50000" });

var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());

Go Request

package main

import (
	"fmt"
	"io"
	"net/http"
	"strings"
)

func main() {
	req, _ := http.NewRequest("POST", "https://YOUR-NETWORK-DOMAIN/rest-api/site/1001/limits/set.do", strings.NewReader(`dailyClicksLimit=2000&dailyConversionsLimit=500&dailyImpressionsLimit=50000`))
	req.Header.Set("X-Api-Key", "YOUR_API_KEY")
	req.Header.Set("Content-Type", "application/x-www-form-urlencoded")

	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/site/1001/limits/set.do");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, ["X-Api-Key: YOUR_API_KEY", "Content-Type: application/x-www-form-urlencoded"]);
curl_setopt($ch, CURLOPT_POSTFIELDS, 'dailyClicksLimit=2000&dailyConversionsLimit=500&dailyImpressionsLimit=50000');

echo curl_exec($ch);
curl_close($ch);

Ruby Request

require 'net/http'
require 'json'

uri = URI("https://YOUR-NETWORK-DOMAIN/rest-api/site/1001/limits/set.do")
request = Net::HTTP::Post.new(uri)
request['X-Api-Key'] = 'YOUR_API_KEY'
request['Content-Type'] = 'application/x-www-form-urlencoded'
request.set_form_data('dailyClicksLimit' => "2000", 'dailyConversionsLimit' => "500", 'dailyImpressionsLimit' => "50000")

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }
puts response.body