Read a serving trace

Reference

GET https://YOUR-NETWORK-DOMAIN/rest-api/serving-traces/{traceId}.do

What the trace recorded so far, added up across the ad servers: how many ad selections it saw on the creative's placements, how often the creative was served, how often it was left out and why (the ad server's exclude reason, e.g. CAPPING, LIMITS, TARGETING), how often it was eligible but another creative won, and which creatives won instead (named only when this account may view their advertiser). status is starting, running or finished. On a busy placement the counts come from a sample, each ad server contributing an equal share of lines: truncated=true says so. An ad server that does not answer within 20 seconds is listed in failedServers (serverId, reason TIMEOUT, UNREACHABLE, HTTP_{status} or ERROR) and its lines are missing from the counts. Only the account that started the trace may read it.

Path Params

traceId integer required

The trace

71

Responses

200

{success, traceId, bannerId, status, endsAt, selectionsSeen, served, excludedBy:{REASON:count}, eligibleButAnotherWon, noAdServedAtAll, servedInstead:[{bannerId, name, served}], servedInsteadByCreativesYouCannotSee?, placements:[{placementId, selections, served}], truncated, failedServers:[{serverId, reason}]}

400

Bad request — invalid or missing parameters

401

Unauthorized — authentication failed or missing credentials

403

Forbidden — insufficient permissions

404

No serving trace with that id started by this account

Language

cURL Request

curl --request GET \
  --url 'https://YOUR-NETWORK-DOMAIN/rest-api/serving-traces/71.do' \
  --header 'X-Api-Key: YOUR_API_KEY'

Python Request

import requests

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

Node Request

const response = await fetch('https://YOUR-NETWORK-DOMAIN/rest-api/serving-traces/71.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/serving-traces/71.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/serving-traces/71.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/serving-traces/71.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/serving-traces/71.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/serving-traces/71.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