Get a header-bidding tag by id

Reference

GET https://YOUR-NETWORK-DOMAIN/rest-api/hb-tags/{tagId}.do

Every field of the tag: id, name, publicId, domain, siteId, siteName, refreshSeconds, bidTimeoutMs, collapseEmpty, loadInViewOnly, refreshInViewOnly, refreshIdleMinutes, refreshForegroundOnly, setDocumentLanguage, adServerWithoutConsent, ourDemandFirst, allowZeroCpmBids, integration (owned, adopt, bidder), bidderCode, active, the Prebid Server addresses (storedRequestsUrl, prebidServerUrl, prebidCacheUrl, prebidSyncUrl, prebidAccountId) and slots, each with id, placementId, placementName, placementKey, slotName, adUnitIds, adUnitPath, rewarded, fallbackCode, storedRequestId, storedImp and bidders (bidderCode, alias, params). code holds what the page carries: script (the tag's script element), containers (one per named slot) and gamKeys (the key-values Google Ad Manager line items target). Requires the HEADER_BIDDING_TAB_VISIBLE permission and access to the tag's site.

Path Params

tagId integer required

Unique numeric ID of the tag

1

Responses

200

{data: tag, code: {script, containers, gamKeys}}

400

Bad request — invalid or missing parameters

401

Authentication error

403

Insufficient permissions, naming the missing one

404

Tag not found or deleted

Language

cURL Request

curl --request GET \
  --url 'https://YOUR-NETWORK-DOMAIN/rest-api/hb-tags/1.do' \
  --header 'X-Api-Key: YOUR_API_KEY'

Python Request

import requests

response = requests.request("GET", "https://YOUR-NETWORK-DOMAIN/rest-api/hb-tags/1.do", headers={"X-Api-Key": "YOUR_API_KEY"})
print(response.json())

Node Request

const response = await fetch('https://YOUR-NETWORK-DOMAIN/rest-api/hb-tags/1.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/hb-tags/1.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/hb-tags/1.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/hb-tags/1.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/hb-tags/1.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/hb-tags/1.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