Compute the deep Traffic Quality analysis of a placement

Starts only the deep analysis of the placement and day, in the background on the analytics cluster: the raw breakdowns GET detail returns, without the AI findings and the PDF.

Reference

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

Starts only the deep analysis of the placement and day, in the background on the analytics cluster: the raw breakdowns GET detail returns, without the AI findings and the PDF. It takes minutes, and is the quicker choice when the caller draws its own conclusions; poll GET detail until status is stored. One analysis or report runs at a time across the network, and a stored analysis is kept. Requires the Traffic Quality Reports permission and view permission on the placement's site.

Path Params

placementId integer required

Placement id

3277

Form Params

date string

Day, yyyy-MM-dd; default yesterday

2026-10-28

Responses

200

{success, placementId, date, status: ready (it is already stored) | started | generating (already running for this placement and day), runningMinutes (while generating)}

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

429

Another placement's analysis or report is running; the message names it and how long it has run

Language

cURL Request

curl --request POST \
  --url 'https://YOUR-NETWORK-DOMAIN/rest-api/traffic-quality/3277/detail.do' \
  --header 'X-Api-Key: YOUR_API_KEY' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data-urlencode 'date=2026-10-28'

Python Request

import requests

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

Node Request

const response = await fetch('https://YOUR-NETWORK-DOMAIN/rest-api/traffic-quality/3277/detail.do', {
  method: 'POST',
  headers: { 'X-Api-Key': 'YOUR_API_KEY', 'Content-Type': 'application/x-www-form-urlencoded' },
  body: new URLSearchParams({"date":"2026-10-28"}),
});

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/detail.do"))
    .header("X-Api-Key", "YOUR_API_KEY")
    .header("Content-Type", "application/x-www-form-urlencoded")
    .method("POST", HttpRequest.BodyPublishers.ofString("date=2026-10-28"))
    .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("POST"), "https://YOUR-NETWORK-DOMAIN/rest-api/traffic-quality/3277/detail.do");
request.Headers.Add("X-Api-Key", "YOUR_API_KEY");
request.Content = new FormUrlEncodedContent(new Dictionary<string, string> { ["date"] = "2026-10-28" });

var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());

Go Request

package main

import (
	"fmt"
	"io"
	"net/http"
	"strings"
)

func main() {
	req, _ := http.NewRequest("POST", "https://YOUR-NETWORK-DOMAIN/rest-api/traffic-quality/3277/detail.do", strings.NewReader(`date=2026-10-28`))
	req.Header.Set("X-Api-Key", "YOUR_API_KEY")
	req.Header.Set("Content-Type", "application/x-www-form-urlencoded")

	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/detail.do");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, ["X-Api-Key: YOUR_API_KEY", "Content-Type: application/x-www-form-urlencoded"]);
curl_setopt($ch, CURLOPT_POSTFIELDS, 'date=2026-10-28');

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/detail.do")
request = Net::HTTP::Post.new(uri)
request['X-Api-Key'] = 'YOUR_API_KEY'
request['Content-Type'] = 'application/x-www-form-urlencoded'
request.set_form_data('date' => "2026-10-28")

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }
puts response.body