Set banner frequency capping — frequency-capping

Creates or replaces the frequency capping rule for a banner, limiting how many times an ad impression is shown within a time window.

Reference

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

Creates or replaces the frequency capping rule for a banner, limiting how many times an ad impression is shown within a time window. If a capping rule already exists for the given subject type, it is updated in place; otherwise a new rule is created. The capping is automatically enabled after this call. Requires UPDATE permission and the MANAGE_CAPPING_AND_LIMITATIONS privilege; using IP or LES_IP subjects requires additional CAPPING_SUBJECT_IP / CAPPING_SUBJECT_LES_IP permissions.

Path Params

bannerId integer required

Numeric ID of the banner to configure frequency capping for

42

Form Params

period integer required

Length of the capping time window, expressed in units defined by periodType (e.g. 24 when periodType is HOUR means 24 hours)

24

periodType string required

Unit of the capping period. Allowed values: SECOND, MINUTE, HOUR, DAY, WEEK, MONTH, YEAR

HOUR

amount integer

Maximum number of impressions allowed within the specified period. Optional; if omitted the existing amount is preserved.

1000

evenDistribution boolean

When true, impressions are distributed evenly across the period instead of being served as fast as possible

true

subject string

Entity used to identify unique users for capping. Defaults to USER_COOKIE if omitted. Allowed values: USER_COOKIE, USER_SERVER_SIDE, USER_MIXED, IP, LES_IP

USER_COOKIE

Responses

200

Frequency capping set successfully

400

Invalid request parameters

401

Authentication error

403

Not enough permissions

404

Banner not found

Language

cURL Request

curl --request POST \
  --url 'https://YOUR-NETWORK-DOMAIN/rest-api/banner/42/frequency-capping/set.do' \
  --header 'X-Api-Key: YOUR_API_KEY' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data-urlencode 'period=24' \
  --data-urlencode 'periodType=HOUR' \
  --data-urlencode 'amount=1000' \
  --data-urlencode 'evenDistribution=true' \
  --data-urlencode 'subject=USER_COOKIE'

Python Request

import requests

response = requests.request("POST", "https://YOUR-NETWORK-DOMAIN/rest-api/banner/42/frequency-capping/set.do", headers={"X-Api-Key": "YOUR_API_KEY"}, data={"period": "24", "periodType": "HOUR", "amount": "1000", "evenDistribution": "true", "subject": "USER_COOKIE"})
print(response.json())

Node Request

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

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

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/42/frequency-capping/set.do", strings.NewReader(`period=24&periodType=HOUR&amount=1000&evenDistribution=true&subject=USER_COOKIE`))
	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/42/frequency-capping/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, 'period=24&periodType=HOUR&amount=1000&evenDistribution=true&subject=USER_COOKIE');

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

Ruby Request

require 'net/http'
require 'json'

uri = URI("https://YOUR-NETWORK-DOMAIN/rest-api/banner/42/frequency-capping/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('period' => "24", 'periodType' => "HOUR", 'amount' => "1000", 'evenDistribution' => "true", 'subject' => "USER_COOKIE")

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