/

Browse the help center

Save site piggyback

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

Reference

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

Creates a new piggyback tracking pixel and attaches it to the specified site, or with 'id' edits that existing piggyback of the site. 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. Optionally associate the piggyback with a specific campaign. The caller must have update permissions on the site. Returns a JSON object with a 'success' boolean and validation errors if any.

Form Params

siteId integer required

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

3001

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, making actionId unnecessary

true

campaignId integer

Optional campaign ID to associate the piggyback with a specific campaign

2001

id integer

ID of an existing piggyback of this site to edit instead of creating a new one; one that is not the site'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?sid=456

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

Site piggyback saved successfully

400

Bad request — invalid or missing parameters

401

Unauthorized - authentication error

403

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

500

Internal server error

Language

cURL Request

curl --request POST \
  --url 'https://YOUR-NETWORK-DOMAIN/rest-api/piggyback/site.do' \
  --header 'X-Api-Key: YOUR_API_KEY' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data-urlencode 'siteId=3001' \
  --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/site.do", headers={"X-Api-Key": "YOUR_API_KEY"}, data={"siteId": "3001", "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/site.do', {
  method: 'POST',
  headers: { 'X-Api-Key': 'YOUR_API_KEY', 'Content-Type': 'application/x-www-form-urlencoded' },
  body: new URLSearchParams({"siteId":"3001","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/site.do"))
    .header("X-Api-Key", "YOUR_API_KEY")
    .header("Content-Type", "application/x-www-form-urlencoded")
    .method("POST", HttpRequest.BodyPublishers.ofString("siteId=3001&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/site.do");
request.Headers.Add("X-Api-Key", "YOUR_API_KEY");
request.Content = new FormUrlEncodedContent(new Dictionary<string, string> { ["siteId"] = "3001", ["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/site.do", strings.NewReader(`siteId=3001&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/site.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, 'siteId=3001&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/site.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('siteId' => "3001", '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