Get a shareable placement preview link

A link that renders the placement exactly as a visitor would see it, served with the given invocation code type.

Reference

GET https://YOUR-NETWORK-DOMAIN/rest-api/placements/{placementId}/preview-link.do

A link that renders the placement exactly as a visitor would see it, served with the given invocation code type. It needs no login, so it can be sent to anyone, and works for 30 days. url is built on the address this request reached the server on; path is the same link without it. servesOnlyWhileActive tells whether the placement, its zone and its site are all switched on - otherwise the preview shows no ad. Without codeType the link renders AJAX when the caller may generate it, else the first type the caller may that the console previews. Requires VIEW access to the placement's site and the invocation-code permission of the rendered type, the same the console's ad-tag card checks.

Path Params

placementId integer required

Placement ID

4001

Query Params

codeType string

Invocation code type: IFRAME_SIMPLE, VIDEO_PLAYER, API, DIRECT_URL, EMAIL, AJAX or JS_MOUNT — the tag the preview renders

AJAX

Responses

200

{success, placementId, path, url, codeType, servesOnlyWhileActive}

400

Unknown code type, or one a placement of this type has no code of

401

Authentication error

403

No VIEW access to the placement's site, or the role may not generate the code type (or, without codeType, any type) for this placement

404

Placement, its zone or its site not found or deleted

Language

cURL Request

curl --request GET \
  --url 'https://YOUR-NETWORK-DOMAIN/rest-api/placements/4001/preview-link.do?codeType=AJAX' \
  --header 'X-Api-Key: YOUR_API_KEY'

Python Request

import requests

response = requests.request("GET", "https://YOUR-NETWORK-DOMAIN/rest-api/placements/4001/preview-link.do?codeType=AJAX", headers={"X-Api-Key": "YOUR_API_KEY"})
print(response.json())

Node Request

const response = await fetch('https://YOUR-NETWORK-DOMAIN/rest-api/placements/4001/preview-link.do?codeType=AJAX', {
  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/placements/4001/preview-link.do?codeType=AJAX"))
    .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/placements/4001/preview-link.do?codeType=AJAX");
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/placements/4001/preview-link.do?codeType=AJAX", 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/placements/4001/preview-link.do?codeType=AJAX");
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/placements/4001/preview-link.do?codeType=AJAX")
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