List per-action limits

Retrieves all per-action conversion limit objects configured for the specified entity type and entity ID.

Reference

GET https://YOUR-NETWORK-DOMAIN/rest-api/per-action/limits/{type}/{entityId}.do

Retrieves all per-action conversion limit objects configured for the specified entity type and entity ID. Per-action limits allow setting daily and total conversion caps on a per-action (goal) basis, in contrast to the global limits endpoints which cap all conversions together. The response JSON contains an 'actionLimits' array where each entry includes the limit ID, entity ID, action ID, totalConversionsLimit, totalConversions, dailyConversionsLimit, and dailyConversions. The entity type must be one of BANNER, CAMPAIGN, ADVERTISER, PLACEMENT, or SITE; unsupported types return 400.

Path Params

type string required

Type of the parent entity whose per-action limits should be listed. Must be one of: BANNER, CAMPAIGN, ADVERTISER, PLACEMENT, SITE

CAMPAIGN

entityId integer required

Unique numeric identifier of the parent entity (banner, campaign, advertiser, placement, or site)

2001

Responses

200

Per-action limits retrieved successfully

400

Invalid parameters or unsupported entity type

401

Authentication error

403

The role lacks the permission the message names, or the entity is not yours to change

404

Not found — resource does not exist

Language

cURL Request

curl --request GET \
  --url 'https://YOUR-NETWORK-DOMAIN/rest-api/per-action/limits/CAMPAIGN/2001.do' \
  --header 'X-Api-Key: YOUR_API_KEY'

Python Request

import requests

response = requests.request("GET", "https://YOUR-NETWORK-DOMAIN/rest-api/per-action/limits/CAMPAIGN/2001.do", headers={"X-Api-Key": "YOUR_API_KEY"})
print(response.json())

Node Request

const response = await fetch('https://YOUR-NETWORK-DOMAIN/rest-api/per-action/limits/CAMPAIGN/2001.do', {
  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/per-action/limits/CAMPAIGN/2001.do"))
    .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/per-action/limits/CAMPAIGN/2001.do");
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/per-action/limits/CAMPAIGN/2001.do", 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/per-action/limits/CAMPAIGN/2001.do");
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/per-action/limits/CAMPAIGN/2001.do")
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