/

Browse the help center

Creative weights — bytes one impression pulls, heaviest creatives first

Reference

GET https://YOUR-NETWORK-DOMAIN/rest-api/banners/weights.do

Lists the creatives the account can see by their weight: the bytes one impression downloads from the network's own servers and CDN, with the files they come from (image, video, the largest advanced-video rendition, native assets, template files, the unpacked HTML5 files, the VPAID script). Files a creative loads from the advertiser's own host cost the network's CDN nothing and are listed at 0 bytes; creatives with nothing of ours are left out unless includeExternal=true. Multiplying a creative's bytes by its impressions estimates the CDN traffic it caused. Weights are recomputed within minutes of a creative being saved and re-read weekly; a creative saved a moment ago may not be listed yet. Each creative carries its media (VIDEO when it serves a video file of ours, else DISPLAY) and the weight it is measured against: the IAB subload limit for its size, the network's limit for sizes IAB has no figure for, or the network's video limit; heavy=true when it is over. The limits are absent when the network has heavy-creative warnings switched off. A size threshold means different things per media - 300 KB is heavy for a banner and small for a video - so filter by media with minBytes, or use heavyOnly; totals splits every match by media.

Query Params

advertiserId integer

Only this advertiser's creatives

1001

campaignId integer

Only this campaign's creatives

2001

bannerIds array<integer>

Only these creatives

3001

includeExternal boolean

Also list creatives whose files all come from the advertiser's host

false

media string

Only creatives that serve a video file of ours (VIDEO), or only the others (DISPLAY)

VIDEO

minBytes integer

Only creatives weighing at least this many bytes per impression

4194304

heavyOnly boolean

Only creatives over their weight limit

false

start integer

Creatives skipped before the first one listed, for paging

0

limit integer

Creatives listed, heaviest first; default 20, at most 500

20

Responses

200

{success, total, more, totals:{VIDEO, DISPLAY}, creatives:[{bannerId, bannerName, bannerType, media, campaignId, campaignName, advertiserId, advertiserName, width, height, bytes, servedByUs, limitBytes, limitBasis, heavy, assets:[{kind, name, bytes, servedByUs}]}]}

400

Bad request — invalid or missing parameters

401

Authentication error

403

The role may not view campaigns and banners

Language

cURL Request

curl --request GET \
  --url 'https://YOUR-NETWORK-DOMAIN/rest-api/banners/weights.do?advertiserId=1001&campaignId=2001&bannerIds=3001&includeExternal=false&media=VIDEO' \
  --header 'X-Api-Key: YOUR_API_KEY'

Python Request

import requests

response = requests.request("GET", "https://YOUR-NETWORK-DOMAIN/rest-api/banners/weights.do?advertiserId=1001&campaignId=2001&bannerIds=3001&includeExternal=false&media=VIDEO", headers={"X-Api-Key": "YOUR_API_KEY"})
print(response.json())

Node Request

const response = await fetch('https://YOUR-NETWORK-DOMAIN/rest-api/banners/weights.do?advertiserId=1001&campaignId=2001&bannerIds=3001&includeExternal=false&media=VIDEO', {
  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/banners/weights.do?advertiserId=1001&campaignId=2001&bannerIds=3001&includeExternal=false&media=VIDEO"))
    .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/banners/weights.do?advertiserId=1001&campaignId=2001&bannerIds=3001&includeExternal=false&media=VIDEO");
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/banners/weights.do?advertiserId=1001&campaignId=2001&bannerIds=3001&includeExternal=false&media=VIDEO", 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/banners/weights.do?advertiserId=1001&campaignId=2001&bannerIds=3001&includeExternal=false&media=VIDEO");
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/banners/weights.do?advertiserId=1001&campaignId=2001&bannerIds=3001&includeExternal=false&media=VIDEO")
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