List publisher video spec presets

The network's publisher video specs (Hulu, Disney+, Peacock, … and its own) as ready-made video creative requirements, each with the publisher's spec page and the date it was read.

Reference

GET https://YOUR-NETWORK-DOMAIN/rest-api/video-requirements/presets.do

The network's publisher video specs (Hulu, Disney+, Peacock, … and its own) as ready-made video creative requirements, each with the publisher's spec page and the date it was read. Apply one to a site with video-requirements/apply-preset, then adjust it if the publisher's current spec differs. active=true lists only the presets offered to sites (the list a site picks from); left out, inactive ones are listed too. Fields: id, name, profile, source (the publisher's spec page), asOf (YYYY-MM-DD or YYYY-MM), notes, requirements (the same fields as a site's video-requirements), active (offered to sites), builtIn (shipped with the platform), updatedAt usedBy, how many live sites' requirements were filled from it, and sitesDiffering, how many of those no longer match it. total counts every preset; more says the list was cut at limit. Requires the SITE_VIDEO_CREATIVE_REQUIREMENTS permission (enabled or read-only) or the VIDEO_REQUIREMENT_PRESETS admin permission.

Query Params

limit integer

How many presets to return, 1-500

100

active boolean

true: only the presets offered to sites; false: only the inactive ones; left out: all

true

Responses

200

{presets: [preset], total, more}

400

Bad request — invalid or missing parameters

401

Authentication error

403

Insufficient permissions, naming the missing one

Language

cURL Request

curl --request GET \
  --url 'https://YOUR-NETWORK-DOMAIN/rest-api/video-requirements/presets.do?active=true&limit=100' \
  --header 'X-Api-Key: YOUR_API_KEY'

Python Request

import requests

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

Node Request

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