Add third-party VAST tracking events — placement

Adds one or more third-party tracking event pixels to the specified entity.

Reference

PUT https://YOUR-NETWORK-DOMAIN/rest-api/placement/{id}/vast/tracking-events.do

Adds one or more third-party tracking event pixels to the specified entity. Each event in the request body JSON array must specify a 'type' (CLICK, IMPRESSION, or EVENT), a valid 'url' to fire, and for EVENT type a 'vastEvent' name (e.g., AD_MUTE). URLs are validated before saving; invalid URLs cause a 400 error. The event list must not be empty. The caller must have update permissions on the entity. Returns a JSON object with a 'success' boolean.

Path Params

id integer required

The unique numeric identifier of the entity to add third-party tracking events to

5001

Body

A JSON body. An example, built from the field definitions:

[
  {
    "id": "12345",
    "url": "https://tracker.example.com/vast?event=impression&cb=[CACHEBUSTER]",
    "type": "EVENT",
    "vastEvent": "AD_START"
  }
]

Responses

200

Third-party tracking events added successfully

400

Invalid URL, event type, or empty event list

401

Authentication error

403

Not enough permissions

404

The entity does not exist or is deleted

Language

cURL Request

curl --request PUT \
  --url 'https://YOUR-NETWORK-DOMAIN/rest-api/placement/5001/vast/tracking-events.do' \
  --header 'X-Api-Key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '[
  {
    "id": "12345",
    "url": "https://tracker.example.com/vast?event=impression&cb=[CACHEBUSTER]",
    "type": "EVENT",
    "vastEvent": "AD_START"
  }
]'

Python Request

import requests

response = requests.request("PUT", "https://YOUR-NETWORK-DOMAIN/rest-api/placement/5001/vast/tracking-events.do", headers={"X-Api-Key": "YOUR_API_KEY"}, json=[
    {
        "id": "12345",
        "url": "https://tracker.example.com/vast?event=impression&cb=[CACHEBUSTER]",
        "type": "EVENT",
        "vastEvent": "AD_START"
    }
])
print(response.json())

Node Request

const response = await fetch('https://YOUR-NETWORK-DOMAIN/rest-api/placement/5001/vast/tracking-events.do', {
  method: 'PUT',
  headers: { 'X-Api-Key': 'YOUR_API_KEY', 'Content-Type': 'application/json' },
  body: JSON.stringify([
    {
      "id": "12345",
      "url": "https://tracker.example.com/vast?event=impression&cb=[CACHEBUSTER]",
      "type": "EVENT",
      "vastEvent": "AD_START"
    }
  ]),
});

console.log(await response.json());

Java Request

HttpClient client = HttpClient.newHttpClient();

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://YOUR-NETWORK-DOMAIN/rest-api/placement/5001/vast/tracking-events.do"))
    .header("X-Api-Key", "YOUR_API_KEY")
    .header("Content-Type", "application/json")
    .method("PUT", HttpRequest.BodyPublishers.ofString("[{\"id\":\"12345\",\"url\":\"https://tracker.example.com/vast?event=impression&cb=[CACHEBUSTER]\",\"type\":\"EVENT\",\"vastEvent\":\"AD_START\"}]"))
    .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("PUT"), "https://YOUR-NETWORK-DOMAIN/rest-api/placement/5001/vast/tracking-events.do");
request.Headers.Add("X-Api-Key", "YOUR_API_KEY");
request.Content = new StringContent("[{\"id\":\"12345\",\"url\":\"https://tracker.example.com/vast?event=impression&cb=[CACHEBUSTER]\",\"type\":\"EVENT\",\"vastEvent\":\"AD_START\"}]", Encoding.UTF8, "application/json");

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("PUT", "https://YOUR-NETWORK-DOMAIN/rest-api/placement/5001/vast/tracking-events.do", strings.NewReader(`[{"id":"12345","url":"https://tracker.example.com/vast?event=impression&cb=[CACHEBUSTER]","type":"EVENT","vastEvent":"AD_START"}]`))
	req.Header.Set("X-Api-Key", "YOUR_API_KEY")
	req.Header.Set("Content-Type", "application/json")

	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/placement/5001/vast/tracking-events.do");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "PUT");
curl_setopt($ch, CURLOPT_HTTPHEADER, ["X-Api-Key: YOUR_API_KEY", "Content-Type: application/json"]);
curl_setopt($ch, CURLOPT_POSTFIELDS, '[{"id":"12345","url":"https://tracker.example.com/vast?event=impression&cb=[CACHEBUSTER]","type":"EVENT","vastEvent":"AD_START"}]');

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

Ruby Request

require 'net/http'
require 'json'

uri = URI("https://YOUR-NETWORK-DOMAIN/rest-api/placement/5001/vast/tracking-events.do")
request = Net::HTTP::Put.new(uri)
request['X-Api-Key'] = 'YOUR_API_KEY'
request['Content-Type'] = 'application/json'
request.body = "[{\"id\":\"12345\",\"url\":\"https://tracker.example.com/vast?event=impression&cb=[CACHEBUSTER]\",\"type\":\"EVENT\",\"vastEvent\":\"AD_START\"}]"

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