Get site video creative requirements

Reference

GET https://YOUR-NETWORK-DOMAIN/rest-api/sites/{siteId}/video-requirements.do

Returns the publisher's video creative requirements set on the site and whether they are switched on (enabled); an empty object means none; preset names the publisher spec they were filled from and whether they were changed since (modified). Every requirement is optional and only those present are checked: resolutions (each with an optional bitrate range in Mbps that wins over videoBitrate), videoBitrate {min, max} in Mbps, durations in seconds with durationTolerance (default 0.5), frameRates, containers (MP4, MOV, WEBM), videoCodecs (H264, HEVC, PRORES, VP9, AV1, MPEG2), audioCodecs (AAC, PCM, AC3, EAC3, MP3, OPUS), minAudioBitrate in kbps, audioChannels, maxFileSizeMb and loudness {target, tolerance} in LKFS. While the site's switch (enabled) is on, an uploaded video (LOCAL_VIDEO, or the best file of ADVANCED_LOCAL_VIDEOS) that fails them is linked as usual but not served on this site's placements; external video, VAST tags and DSP bids are not checked. Off keeps them but checks nothing. Requires VIEW access to the site and the SITE_VIDEO_CREATIVE_REQUIREMENTS permission (enabled or read-only).

Path Params

siteId integer required

Unique numeric ID of the site

5001

Responses

200

The site's requirements

400

Bad request — invalid or missing parameters

401

Authentication error

403

Insufficient permissions, naming the missing one

404

Site not found or deleted

Language

cURL Request

curl --request GET \
  --url 'https://YOUR-NETWORK-DOMAIN/rest-api/sites/5001/video-requirements.do' \
  --header 'X-Api-Key: YOUR_API_KEY'

Python Request

import requests

response = requests.request("GET", "https://YOUR-NETWORK-DOMAIN/rest-api/sites/5001/video-requirements.do", headers={"X-Api-Key": "YOUR_API_KEY"})
print(response.json())

Node Request

const response = await fetch('https://YOUR-NETWORK-DOMAIN/rest-api/sites/5001/video-requirements.do', {
  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/sites/5001/video-requirements.do"))
    .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/sites/5001/video-requirements.do");
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/sites/5001/video-requirements.do", 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/sites/5001/video-requirements.do");
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/sites/5001/video-requirements.do")
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