Reset banner limits

Resets one or more limit counter values back to zero for the specified banner.

Reference

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

Resets one or more limit counter values back to zero for the specified banner. Each counter type specified in the request is independently reset, and a delayed reset is also initiated in the ad serving layer to synchronize counters across the cluster. Counters that can be reset: any counter of the limit: DAILY_, WEEKLY_, MONTHLY_ or TOTAL_ followed by IMPRESSIONS, CLICKS, CONVERSIONS, REVENUE or OPPORTUNITIES (e.g. WEEKLY_CLICKS). Requires UPDATE permission on the banner's parent advertiser and the MANAGE_CAPPING_AND_LIMITATIONS user permission. Returns 404 if limits are not enabled. Each counter also needs its own limit permission enabled (e.g. WEEKLY_CLICKS_LIMIT for WEEKLY_CLICKS).

Path Params

bannerId integer required

Unique numeric identifier of the banner whose limit counters should be reset

42

Form Params

limitCounters array<string> required

Counters to reset to zero, at least one, comma-separated or repeated: any counter of the limit: DAILY_, WEEKLY_, MONTHLY_ or TOTAL_ followed by IMPRESSIONS, CLICKS, CONVERSIONS, REVENUE or OPPORTUNITIES (e.g. WEEKLY_CLICKS)

TOTAL_IMPRESSIONS

Responses

200

Banner limits reset successfully

400

Invalid request parameters or banner not found

401

Authentication error

403

Not enough permissions

404

No limit enabled for the banner

Language

cURL Request

curl --request POST \
  --url 'https://YOUR-NETWORK-DOMAIN/rest-api/banner/42/limits/reset.do' \
  --header 'X-Api-Key: YOUR_API_KEY' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data-urlencode 'limitCounters=TOTAL_IMPRESSIONS'

Python Request

import requests

response = requests.request("POST", "https://YOUR-NETWORK-DOMAIN/rest-api/banner/42/limits/reset.do", headers={"X-Api-Key": "YOUR_API_KEY"}, data={"limitCounters": "TOTAL_IMPRESSIONS"})
print(response.json())

Node Request

const response = await fetch('https://YOUR-NETWORK-DOMAIN/rest-api/banner/42/limits/reset.do', {
  method: 'POST',
  headers: { 'X-Api-Key': 'YOUR_API_KEY', 'Content-Type': 'application/x-www-form-urlencoded' },
  body: new URLSearchParams({"limitCounters":"TOTAL_IMPRESSIONS"}),
});

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/reset.do"))
    .header("X-Api-Key", "YOUR_API_KEY")
    .header("Content-Type", "application/x-www-form-urlencoded")
    .method("POST", HttpRequest.BodyPublishers.ofString("limitCounters=TOTAL_IMPRESSIONS"))
    .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/limits/reset.do");
request.Headers.Add("X-Api-Key", "YOUR_API_KEY");
request.Content = new FormUrlEncodedContent(new Dictionary<string, string> { ["limitCounters"] = "TOTAL_IMPRESSIONS" });

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/limits/reset.do", strings.NewReader(`limitCounters=TOTAL_IMPRESSIONS`))
	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/limits/reset.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, 'limitCounters=TOTAL_IMPRESSIONS');

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/reset.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('limitCounters' => "TOTAL_IMPRESSIONS")

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