Get prototype actions by banner IDs

Retrieves the default action configurations for banner prototypes that match the specified set of banner IDs.

Reference

GET https://YOUR-NETWORK-DOMAIN/rest-api/prototype/banner/action.do

Retrieves the default action configurations for banner prototypes that match the specified set of banner IDs. This is useful for bulk-loading action tracking URLs (click tracking, pixel tracking, sub-ID tracking) for multiple banners at once. The response contains a JSON array of unique action objects extracted from the matching prototypes. The returned actionTrackUrl and subIdActionTrackUrl carry an att= placeholder — replace it with click or view to declare how the conversion was attributed, or fire the URL as is, which is read as no declaration. Requires REST API authentication.

Query Params

bannerIds array<integer> required

Comma-separated set of unique numeric banner IDs to look up prototype actions for (e.g. bannerIds=838,839,840)

5001

Responses

200

JSON array of action objects, each containing id, actionTrackUrl, pixelTracking, securePixelTracking, subIdActionTrackUrl, and code

400

Bad request — invalid or missing parameters

401

Authentication error - invalid hash, timestamp, or username

403

Forbidden — insufficient permissions

500

Internal server error while retrieving prototype actions

Language

cURL Request

curl --request GET \
  --url 'https://YOUR-NETWORK-DOMAIN/rest-api/prototype/banner/action.do?bannerIds=5001' \
  --header 'X-Api-Key: YOUR_API_KEY'

Python Request

import requests

response = requests.request("GET", "https://YOUR-NETWORK-DOMAIN/rest-api/prototype/banner/action.do?bannerIds=5001", headers={"X-Api-Key": "YOUR_API_KEY"})
print(response.json())

Node Request

const response = await fetch('https://YOUR-NETWORK-DOMAIN/rest-api/prototype/banner/action.do?bannerIds=5001', {
  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/prototype/banner/action.do?bannerIds=5001"))
    .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/prototype/banner/action.do?bannerIds=5001");
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/prototype/banner/action.do?bannerIds=5001", 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/prototype/banner/action.do?bannerIds=5001");
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/prototype/banner/action.do?bannerIds=5001")
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