Get banner by ID

Retrieves full details of a single banner by its ID, including labels, linkage status, traffic state, and native preferences (for native placement banners).

Reference

GET https://YOUR-NETWORK-DOMAIN/rest-api/banner/{bannerId}.do

Retrieves full details of a single banner by its ID, including labels, linkage status, traffic state, and native preferences (for native placement banners). The user must have VIEW permission on the banner's advertiser. Returns 404 if the banner does not exist or has been deleted. The response also carries additionalFieldValues: every custom field the network defines for this entity type, keyed by field id, each with its name and this entity's value (null when unset) - the values of /rest-api/additional-fields/{entityType}/{entityId}.

Path Params

bannerId integer required

ID of the banner to retrieve

3001

Query Params

selfServRequest boolean

If true, returns the Self-Serve response format

false

Responses

200

Banner details

400

Bad request — invalid or missing parameters

401

Authentication error

403

Not enough permissions

404

Banner not found

Language

cURL Request

curl --request GET \
  --url 'https://YOUR-NETWORK-DOMAIN/rest-api/banner/3001.do?selfServRequest=false' \
  --header 'X-Api-Key: YOUR_API_KEY'

Python Request

import requests

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

Node Request

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