Get the Traffic Quality report of a placement

Reference

GET https://YOUR-NETWORK-DOMAIN/rest-api/traffic-quality/{placementId}/report.do

Whether the placement's report for the day is ready, being generated, failed (with the reason) or not started, with its AI findings (verdict, summary, the signals behind them and recommendations) and a download link to the PDF once it is ready. Findings are absent for a report made before they were stored or without an Anthropic key. Requires the Traffic Quality Reports permission and view permission on the placement's site.

Path Params

placementId integer required

Placement id

3277

Query Params

date string

Day, yyyy-MM-dd; default yesterday

2026-10-28

Responses

200

{success, placementId, date, status: ready | generating | failed | none, runningMinutes (while generating), failure (when failed), analysis {...} | null, pdfUrl | null}

400

A date that is not yyyy-MM-dd

401

Authentication error

403

The role lacks the Traffic Quality Reports permission or view permission on the site

404

No such placement, or no score for it that day

Language

cURL Request

curl --request GET \
  --url 'https://YOUR-NETWORK-DOMAIN/rest-api/traffic-quality/3277/report.do?date=2026-10-28' \
  --header 'X-Api-Key: YOUR_API_KEY'

Python Request

import requests

response = requests.request("GET", "https://YOUR-NETWORK-DOMAIN/rest-api/traffic-quality/3277/report.do?date=2026-10-28", headers={"X-Api-Key": "YOUR_API_KEY"})
print(response.json())

Node Request

const response = await fetch('https://YOUR-NETWORK-DOMAIN/rest-api/traffic-quality/3277/report.do?date=2026-10-28', {
  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/traffic-quality/3277/report.do?date=2026-10-28"))
    .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/traffic-quality/3277/report.do?date=2026-10-28");
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/traffic-quality/3277/report.do?date=2026-10-28", 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/traffic-quality/3277/report.do?date=2026-10-28");
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/traffic-quality/3277/report.do?date=2026-10-28")
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