Batch add banner tracking codes

Adds the same 3rd party tracking code to multiple banners in a single batch request.

Reference

POST https://YOUR-NETWORK-DOMAIN/rest-api/tracking-code/banner/add/batch.do

Adds the same 3rd party tracking code to multiple banners in a single batch request. Each banner in the domainIds array receives the same tracking code for the specified country. If a tracking code already exists for a given banner-country pair, it will be overwritten. The response is a JSON map keyed by banner ID, where each value is an object with a 'success' boolean indicating the result for that banner.

Form Params

domainIds array<integer> required

Array of unique numeric banner identifiers to add the tracking code to

5001

country string required

ISO country code to target (e.g., 'US', 'GB'), or '*' to set a global tracking code that applies to all countries

US

code string required

The HTML tracking code snippet to be injected during ad serving for each banner and the specified country

<img src='https://tracker.example.com/pixel.gif' />

Responses

200

Map of banner IDs to operation results

400

Bad request — invalid or missing parameters

401

Authentication error

403

Forbidden — insufficient permissions

Language

cURL Request

curl --request POST \
  --url 'https://YOUR-NETWORK-DOMAIN/rest-api/tracking-code/banner/add/batch.do' \
  --header 'X-Api-Key: YOUR_API_KEY' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data-urlencode 'domainIds=5001' \
  --data-urlencode 'country=US' \
  --data-urlencode 'code=<img src='\''https://tracker.example.com/pixel.gif'\'' />'

Python Request

import requests

response = requests.request("POST", "https://YOUR-NETWORK-DOMAIN/rest-api/tracking-code/banner/add/batch.do", headers={"X-Api-Key": "YOUR_API_KEY"}, data={"domainIds": "5001", "country": "US", "code": "<img src='https://tracker.example.com/pixel.gif' />"})
print(response.json())

Node Request

const response = await fetch('https://YOUR-NETWORK-DOMAIN/rest-api/tracking-code/banner/add/batch.do', {
  method: 'POST',
  headers: { 'X-Api-Key': 'YOUR_API_KEY', 'Content-Type': 'application/x-www-form-urlencoded' },
  body: new URLSearchParams({"domainIds":"5001","country":"US","code":"<img src='https://tracker.example.com/pixel.gif' />"}),
});

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

Java Request

HttpClient client = HttpClient.newHttpClient();

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://YOUR-NETWORK-DOMAIN/rest-api/tracking-code/banner/add/batch.do"))
    .header("X-Api-Key", "YOUR_API_KEY")
    .header("Content-Type", "application/x-www-form-urlencoded")
    .method("POST", HttpRequest.BodyPublishers.ofString("domainIds=5001&country=US&code=%3Cimg%20src%3D'https%3A%2F%2Ftracker.example.com%2Fpixel.gif'%20%2F%3E"))
    .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/tracking-code/banner/add/batch.do");
request.Headers.Add("X-Api-Key", "YOUR_API_KEY");
request.Content = new FormUrlEncodedContent(new Dictionary<string, string> { ["domainIds"] = "5001", ["country"] = "US", ["code"] = "<img src='https://tracker.example.com/pixel.gif' />" });

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/tracking-code/banner/add/batch.do", strings.NewReader(`domainIds=5001&country=US&code=%3Cimg%20src%3D'https%3A%2F%2Ftracker.example.com%2Fpixel.gif'%20%2F%3E`))
	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/tracking-code/banner/add/batch.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, 'domainIds=5001&country=US&code=%3Cimg%20src%3D\'https%3A%2F%2Ftracker.example.com%2Fpixel.gif\'%20%2F%3E');

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

Ruby Request

require 'net/http'
require 'json'

uri = URI("https://YOUR-NETWORK-DOMAIN/rest-api/tracking-code/banner/add/batch.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('domainIds' => "5001", 'country' => "US", 'code' => "<img src='https://tracker.example.com/pixel.gif' />")

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