List upstream macro presets

The upstreams that can call a video placement's VAST tag server-side (SpringServe, AWS MediaTailor, Google DAI, FreeWheel, Publica, …) and the macro each fills our tag's parameters with.

Reference

GET https://YOUR-NETWORK-DOMAIN/rest-api/upstream-macro-presets.do

The upstreams that can call a video placement's VAST tag server-side (SpringServe, AWS MediaTailor, Google DAI, FreeWheel, Publica, …) and the macro each fills our tag's parameters with. Pick one on a video placement as ssaiStitcher (placements/{placementId}/video-settings) and its tags carry every macro. active=true lists only the presets offered on placements. Fields: id, code (what a placement's ssaiStitcher names), name, source (the upstream's macro documentation), asOf, notes, playerParamPrefix, macros (tag parameter → the upstream's macro, in tag order), active (offered on placements), builtIn (shipped with the platform), updatedAt, usedBy (live video placements whose tags it fills). parameters lists every tag parameter a preset may fill, with its group.

Query Params

active boolean

true: only the presets offered on placements; false: only the inactive ones; left out: all

true

Responses

200

{presets: [preset], total, parameters: [{parameter, group}]}

400

Bad request — invalid or missing parameters

401

Authentication error

403

Forbidden — insufficient permissions

Language

cURL Request

curl --request GET \
  --url 'https://YOUR-NETWORK-DOMAIN/rest-api/upstream-macro-presets.do?active=true' \
  --header 'X-Api-Key: YOUR_API_KEY'

Python Request

import requests

response = requests.request("GET", "https://YOUR-NETWORK-DOMAIN/rest-api/upstream-macro-presets.do?active=true", headers={"X-Api-Key": "YOUR_API_KEY"})
print(response.json())

Node Request

const response = await fetch('https://YOUR-NETWORK-DOMAIN/rest-api/upstream-macro-presets.do?active=true', {
  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/upstream-macro-presets.do?active=true"))
    .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/upstream-macro-presets.do?active=true");
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/upstream-macro-presets.do?active=true", 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/upstream-macro-presets.do?active=true");
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/upstream-macro-presets.do?active=true")
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