Add VAST progress events — banner

Adds one or more VAST progress tracking events to the specified entity, each defining a time offset and an associated action.

Reference

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

Adds one or more VAST progress tracking events to the specified entity, each defining a time offset and an associated action. The request body is a JSON array of objects with 'time' (in HH:MM:SS.mmm format or percentage like '25%') and 'actionId' (the action to trigger at that time). Each actionId must reference a valid existing action and must not be duplicated within the same request. An event for an actionId the entity already has is not added again: that event gets the new time, and the answer lists such actionIds in 'replacedActionIds'. 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 progress events to

5001

Body

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

[
  {
    "id": "789",
    "time": "00:00:15",
    "actionId": "42"
  }
]

Responses

200

VAST progress events added successfully

400

Invalid time format, missing action ID, 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/banner/5001/vast/progress-events.do' \
  --header 'X-Api-Key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '[
  {
    "id": "789",
    "time": "00:00:15",
    "actionId": "42"
  }
]'

Python Request

import requests

response = requests.request("PUT", "https://YOUR-NETWORK-DOMAIN/rest-api/banner/5001/vast/progress-events.do", headers={"X-Api-Key": "YOUR_API_KEY"}, json=[
    {
        "id": "789",
        "time": "00:00:15",
        "actionId": "42"
    }
])
print(response.json())

Node Request

const response = await fetch('https://YOUR-NETWORK-DOMAIN/rest-api/banner/5001/vast/progress-events.do', {
  method: 'PUT',
  headers: { 'X-Api-Key': 'YOUR_API_KEY', 'Content-Type': 'application/json' },
  body: JSON.stringify([
    {
      "id": "789",
      "time": "00:00:15",
      "actionId": "42"
    }
  ]),
});

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

Java Request

HttpClient client = HttpClient.newHttpClient();

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://YOUR-NETWORK-DOMAIN/rest-api/banner/5001/vast/progress-events.do"))
    .header("X-Api-Key", "YOUR_API_KEY")
    .header("Content-Type", "application/json")
    .method("PUT", HttpRequest.BodyPublishers.ofString("[{\"id\":\"789\",\"time\":\"00:00:15\",\"actionId\":\"42\"}]"))
    .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/banner/5001/vast/progress-events.do");
request.Headers.Add("X-Api-Key", "YOUR_API_KEY");
request.Content = new StringContent("[{\"id\":\"789\",\"time\":\"00:00:15\",\"actionId\":\"42\"}]", 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/banner/5001/vast/progress-events.do", strings.NewReader(`[{"id":"789","time":"00:00:15","actionId":"42"}]`))
	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/banner/5001/vast/progress-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":"789","time":"00:00:15","actionId":"42"}]');

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

Ruby Request

require 'net/http'
require 'json'

uri = URI("https://YOUR-NETWORK-DOMAIN/rest-api/banner/5001/vast/progress-events.do")
request = Net::HTTP::Put.new(uri)
request['X-Api-Key'] = 'YOUR_API_KEY'
request['Content-Type'] = 'application/json'
request.body = "[{\"id\":\"789\",\"time\":\"00:00:15\",\"actionId\":\"42\"}]"

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