Get a video banner's file facts and publisher compliance

Reference

GET https://YOUR-NETWORK-DOMAIN/rest-api/banner/{bannerId}/video-compliance.do

For an uploaded video (LOCAL_VIDEO, or the best file of ADVANCED_LOCAL_VIDEOS — the one served as the mezzanine): the facts read from its file — size, duration, video bitrate, frame rate, codecs, container, audio, file size, loudness (LKFS) — and, with the SITE_VIDEO_CREATIVE_REQUIREMENTS permission (enabled or read-only), for every site it is linked to through a video placement that has video creative requirements: whether the file meets them and, if not, each failed requirement. A failing file stays linked but is not served on that site. checked is false for other creatives (external video, VAST tags, DSP), which are never checked. A requirement listed in unchecked was not checked because the file was uploaded before that fact was read; it does not stop the creative. Requires VIEW permission on the banner's advertiser.

Path Params

bannerId integer required

ID of the banner

3001

Responses

200

File facts and compliance per site

400

Bad request — invalid or missing parameters

401

Authentication error

403

Not enough permissions

404

Banner not found

Language

cURL Request

curl --request GET \
  --url 'https://YOUR-NETWORK-DOMAIN/rest-api/banner/3001/video-compliance.do' \
  --header 'X-Api-Key: YOUR_API_KEY'

Python Request

import requests

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

Node Request

const response = await fetch('https://YOUR-NETWORK-DOMAIN/rest-api/banner/3001/video-compliance.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/banner/3001/video-compliance.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/banner/3001/video-compliance.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/banner/3001/video-compliance.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/banner/3001/video-compliance.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/banner/3001/video-compliance.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