/

Browse the help center

Set banner frequency capping — capping

Creates or adds a frequency capping rule for the specified banner.

Reference

POST https://YOUR-NETWORK-DOMAIN/rest-api/banner/{bannerId}/capping/frequency.do

Creates or adds a frequency capping rule for the specified banner. Accepts amount (number of events), periodType (HOUR, DAY, WEEK, MONTH, YEAR), period (number of periods), and flat (boolean for uniform distribution). The amount must be greater than zero. Requires UPDATE permission on the banner's advertiser, plus MANAGE_CAPPING_AND_LIMITATIONS and FREQUENCY_CAPPING permissions.

Path Params

bannerId integer required

ID of the banner to set frequency capping for

3001

Form Params

amount integer

Maximum number of impressions/clicks allowed within the capping period

5

flat boolean

Whether to use flat (non-rolling) period windows

false

id integer

Frequency capping rule ID

200

period integer

Length of the capping period (combined with periodType)

1

periodType string

Period type for the capping window (MINUTE, HOUR, DAY, WEEK, MONTH, YEAR)

HOUR

subject string

Subject type for capping identification (USER_COOKIE, USER_SERVER_SIDE, USER_MIXED, IP, LES_IP)

USER_COOKIE

Responses

200

Frequency capping updated

400

Invalid request or banner not found

401

Authentication error

403

Not enough permissions

404

Not found — resource does not exist

Language

cURL Request

curl --request POST \
  --url 'https://YOUR-NETWORK-DOMAIN/rest-api/banner/3001/capping/frequency.do' \
  --header 'X-Api-Key: YOUR_API_KEY' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data-urlencode 'amount=5' \
  --data-urlencode 'period=1' \
  --data-urlencode 'periodType=HOUR' \
  --data-urlencode 'subject=USER_COOKIE' \
  --data-urlencode 'flat=false'

Python Request

import requests

response = requests.request("POST", "https://YOUR-NETWORK-DOMAIN/rest-api/banner/3001/capping/frequency.do", headers={"X-Api-Key": "YOUR_API_KEY"}, data={"amount": "5", "period": "1", "periodType": "HOUR", "subject": "USER_COOKIE", "flat": "false"})
print(response.json())

Node Request

const response = await fetch('https://YOUR-NETWORK-DOMAIN/rest-api/banner/3001/capping/frequency.do', {
  method: 'POST',
  headers: { 'X-Api-Key': 'YOUR_API_KEY', 'Content-Type': 'application/x-www-form-urlencoded' },
  body: new URLSearchParams({"amount":"5","period":"1","periodType":"HOUR","subject":"USER_COOKIE","flat":"false"}),
});

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/3001/capping/frequency.do"))
    .header("X-Api-Key", "YOUR_API_KEY")
    .header("Content-Type", "application/x-www-form-urlencoded")
    .method("POST", HttpRequest.BodyPublishers.ofString("amount=5&period=1&periodType=HOUR&subject=USER_COOKIE&flat=false"))
    .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/banner/3001/capping/frequency.do");
request.Headers.Add("X-Api-Key", "YOUR_API_KEY");
request.Content = new FormUrlEncodedContent(new Dictionary<string, string> { ["amount"] = "5", ["period"] = "1", ["periodType"] = "HOUR", ["subject"] = "USER_COOKIE", ["flat"] = "false" });

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/banner/3001/capping/frequency.do", strings.NewReader(`amount=5&period=1&periodType=HOUR&subject=USER_COOKIE&flat=false`))
	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/banner/3001/capping/frequency.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, 'amount=5&period=1&periodType=HOUR&subject=USER_COOKIE&flat=false');

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

Ruby Request

require 'net/http'
require 'json'

uri = URI("https://YOUR-NETWORK-DOMAIN/rest-api/banner/3001/capping/frequency.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('amount' => "5", 'period' => "1", 'periodType' => "HOUR", 'subject' => "USER_COOKIE", 'flat' => "false")

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