Get placement piggybacks

Retrieves all piggyback tracking pixels currently associated with the specified placement.

Reference

GET https://YOUR-NETWORK-DOMAIN/rest-api/piggyback/placement/get.do

Retrieves all piggyback tracking pixels currently associated with the specified placement. The response JSON contains a 'placement_piggybacks' array with each piggyback's ID, type (BEACON or URL), code/URL value, status, and sampling configuration. The caller must have view permissions on the placement's parent site and the Piggyback Pixel Tracking permission. The list comes back whether the placement's piggybacks are switched on or off, as the console grid shows it; 'piggybacksEnabled' tells which - while it is false none of them fire.

Query Params

placementId integer required

The unique numeric identifier of the placement whose piggyback tracking pixels should be retrieved

4001

Responses

200

Placement piggybacks retrieved successfully

400

Bad request — invalid or missing parameters

401

Unauthorized - authentication error

403

Forbidden - not enough permissions

404

Placement not found

Language

cURL Request

curl --request GET \
  --url 'https://YOUR-NETWORK-DOMAIN/rest-api/piggyback/placement/get.do?placementId=4001' \
  --header 'X-Api-Key: YOUR_API_KEY'

Python Request

import requests

response = requests.request("GET", "https://YOUR-NETWORK-DOMAIN/rest-api/piggyback/placement/get.do?placementId=4001", headers={"X-Api-Key": "YOUR_API_KEY"})
print(response.json())

Node Request

const response = await fetch('https://YOUR-NETWORK-DOMAIN/rest-api/piggyback/placement/get.do?placementId=4001', {
  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/piggyback/placement/get.do?placementId=4001"))
    .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/piggyback/placement/get.do?placementId=4001");
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/piggyback/placement/get.do?placementId=4001", 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/piggyback/placement/get.do?placementId=4001");
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/piggyback/placement/get.do?placementId=4001")
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