/

Browse the help center

Save placement piggyback

Creates a new piggyback tracking pixel and attaches it to the specified placement, or with 'id' edits that existing piggyback of the placement.

Reference

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

Creates a new piggyback tracking pixel and attaches it to the specified placement, or with 'id' edits that existing piggyback of the placement. The piggyback can be of type BEACON (HTML tracking code snippet) or URL (redirect URL), specified via the model attribute fields 'type' and 'codeUrl'. You can target a specific action by providing actionId, or set allActions to true to apply to all actions of the campaign. The caller must have update permissions on the placement's parent site. Returns a JSON object with a 'success' boolean and validation errors if any.

Form Params

placementId integer required

The unique numeric identifier of the placement to attach the new piggyback tracking pixel to

4001

campaignId integer required

The unique numeric identifier of the campaign that the placement belongs to

2001

actionId integer

Conditionally required — when allActions is false; ignored when it is true. The unique numeric identifier of the action to attach the piggyback to

101

allActions boolean

When true, the piggyback is applied to all actions of the campaign, making actionId unnecessary

true

id integer

ID of an existing piggyback of this placement to edit instead of creating a new one; one that is not the placement's answers 400

701

active boolean

Whether this piggyback is active

true

codeUrl string

Piggyback URL or HTML/JavaScript code

https://tracker.example.com/pixel?pid=789

deliveryAttribution string

Which conversions this piggyback fires for: ALL, POST_CLICK_ONLY or POST_VIEW_ONLY

ALL

sampling integer

Sampling rate percentage (0-100) controlling how often the piggyback fires

100

type string

Piggyback type: URL (a URL fired as a pixel) or BEACON (an HTML/JavaScript snippet)

URL

Responses

200

Placement piggyback saved successfully

400

Bad request — invalid or missing parameters

401

Unauthorized - authentication error

403

Forbidden - no update rights on the placement, or the Piggyback Pixel Tracking permission is not enabled

404

Placement not found or deleted, or campaign not found

500

Internal server error

Language

cURL Request

curl --request POST \
  --url 'https://YOUR-NETWORK-DOMAIN/rest-api/piggyback/placement.do' \
  --header 'X-Api-Key: YOUR_API_KEY' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data-urlencode 'placementId=4001' \
  --data-urlencode 'campaignId=2001' \
  --data-urlencode 'id=701' \
  --data-urlencode 'type=URL' \
  --data-urlencode 'active=true' \
  --data-urlencode 'actionId=101'

Python Request

import requests

response = requests.request("POST", "https://YOUR-NETWORK-DOMAIN/rest-api/piggyback/placement.do", headers={"X-Api-Key": "YOUR_API_KEY"}, data={"placementId": "4001", "campaignId": "2001", "id": "701", "type": "URL", "active": "true", "actionId": "101"})
print(response.json())

Node Request

const response = await fetch('https://YOUR-NETWORK-DOMAIN/rest-api/piggyback/placement.do', {
  method: 'POST',
  headers: { 'X-Api-Key': 'YOUR_API_KEY', 'Content-Type': 'application/x-www-form-urlencoded' },
  body: new URLSearchParams({"placementId":"4001","campaignId":"2001","id":"701","type":"URL","active":"true","actionId":"101"}),
});

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.do"))
    .header("X-Api-Key", "YOUR_API_KEY")
    .header("Content-Type", "application/x-www-form-urlencoded")
    .method("POST", HttpRequest.BodyPublishers.ofString("placementId=4001&campaignId=2001&id=701&type=URL&active=true&actionId=101"))
    .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("POST"), "https://YOUR-NETWORK-DOMAIN/rest-api/piggyback/placement.do");
request.Headers.Add("X-Api-Key", "YOUR_API_KEY");
request.Content = new FormUrlEncodedContent(new Dictionary<string, string> { ["placementId"] = "4001", ["campaignId"] = "2001", ["id"] = "701", ["type"] = "URL", ["active"] = "true", ["actionId"] = "101" });

var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());

Go Request

package main

import (
	"fmt"
	"io"
	"net/http"
	"strings"
)

func main() {
	req, _ := http.NewRequest("POST", "https://YOUR-NETWORK-DOMAIN/rest-api/piggyback/placement.do", strings.NewReader(`placementId=4001&campaignId=2001&id=701&type=URL&active=true&actionId=101`))
	req.Header.Set("X-Api-Key", "YOUR_API_KEY")
	req.Header.Set("Content-Type", "application/x-www-form-urlencoded")

	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.do");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, ["X-Api-Key: YOUR_API_KEY", "Content-Type: application/x-www-form-urlencoded"]);
curl_setopt($ch, CURLOPT_POSTFIELDS, 'placementId=4001&campaignId=2001&id=701&type=URL&active=true&actionId=101');

echo curl_exec($ch);
curl_close($ch);

Ruby Request

require 'net/http'
require 'json'

uri = URI("https://YOUR-NETWORK-DOMAIN/rest-api/piggyback/placement.do")
request = Net::HTTP::Post.new(uri)
request['X-Api-Key'] = 'YOUR_API_KEY'
request['Content-Type'] = 'application/x-www-form-urlencoded'
request.set_form_data('placementId' => "4001", 'campaignId' => "2001", 'id' => "701", 'type' => "URL", 'active' => "true", 'actionId' => "101")

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }
puts response.body