Add banner tracking code

Adds or replaces a 3rd party tracking code for the specified banner and country combination.

Reference

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

Adds or replaces a 3rd party tracking code for the specified banner and country combination. If a tracking code already exists for the same banner and country, it will be overwritten with the new value. Use country code '*' to set a global tracking code that fires for all countries. Returns a JSON object with a 'success' boolean indicating whether the operation completed successfully.

Form Params

domainId integer required

The unique numeric identifier of the banner 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 the specified country

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

Responses

200

Operation result with success status

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.do' \
  --header 'X-Api-Key: YOUR_API_KEY' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data-urlencode 'domainId=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.do", headers={"X-Api-Key": "YOUR_API_KEY"}, data={"domainId": "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.do', {
  method: 'POST',
  headers: { 'X-Api-Key': 'YOUR_API_KEY', 'Content-Type': 'application/x-www-form-urlencoded' },
  body: new URLSearchParams({"domainId":"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.do"))
    .header("X-Api-Key", "YOUR_API_KEY")
    .header("Content-Type", "application/x-www-form-urlencoded")
    .method("POST", HttpRequest.BodyPublishers.ofString("domainId=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.do");
request.Headers.Add("X-Api-Key", "YOUR_API_KEY");
request.Content = new FormUrlEncodedContent(new Dictionary<string, string> { ["domainId"] = "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.do", strings.NewReader(`domainId=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.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, 'domainId=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.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('domainId' => "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