Review Brand Insights Route
curl --request POST \
--url https://api.example.com/api/v1/brands/{brand_id}/brand-intelligence/review-brand-insights \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"advertiser_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"refresh": false
}
'import requests
url = "https://api.example.com/api/v1/brands/{brand_id}/brand-intelligence/review-brand-insights"
payload = {
"advertiser_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"refresh": False
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({advertiser_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a', refresh: false})
};
fetch('https://api.example.com/api/v1/brands/{brand_id}/brand-intelligence/review-brand-insights', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/api/v1/brands/{brand_id}/brand-intelligence/review-brand-insights",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'advertiser_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'refresh' => false
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/api/v1/brands/{brand_id}/brand-intelligence/review-brand-insights"
payload := strings.NewReader("{\n \"advertiser_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"refresh\": false\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/api/v1/brands/{brand_id}/brand-intelligence/review-brand-insights")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"advertiser_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"refresh\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v1/brands/{brand_id}/brand-intelligence/review-brand-insights")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"advertiser_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"refresh\": false\n}"
response = http.request(request)
puts response.read_body{
"advertiser_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"platform": "trustpilot",
"available_platforms": [
"trustpilot"
],
"aspect_matrix": {
"platform": "trustpilot",
"aspects": [
"<string>"
],
"aspect_slugs": [
"<string>"
],
"vocabulary_is_core_only": false,
"vocabulary_assumed": [
"<string>"
],
"vocabulary_mixed": [
"<string>"
],
"min_mentions": 0,
"brands_total": 0,
"brands_examined": 0,
"reviews_total": 0,
"reviews_classified_total": 0,
"reviews_examined_total": 0,
"basis_notice": "Computed over AITasker's depth-capped sample of collected reviews, and within that only the reviews we classified — not the platform's full review population. Unclassified and uncollected reviews are excluded from every figure rather than counted as zero.",
"rows": [
{
"advertiser_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"domain": "<string>",
"reviews_total": 0,
"reviews_classified": 0,
"reviews_examined": 0,
"reviews_unclassified": 0,
"reviews_not_examined": 0,
"reviews_no_aspect_found": 0,
"segment": "<string>",
"segment_source": "<string>",
"cells": [
{
"aspect": "<string>",
"mentions": 0,
"positive": 0,
"negative": 0,
"mixed": 0,
"neutral": 0,
"positive_pct": 50,
"negative_pct": 50,
"cohort_median_positive_pct": 50,
"cohort_median_negative_pct": 50,
"positive_delta_pp": 0,
"negative_delta_pp": 0,
"benchmark_brand_count": 0,
"not_measured_reason": "brand_not_classified",
"evidence": [
{
"review_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"sentiment": "positive",
"evidence": "<string>",
"evidence_rank": 2,
"platform": "<string>",
"source_url": "<string>",
"reviewer_name": "<string>",
"reviewed_at": "2023-11-07T05:31:56Z"
}
]
}
]
}
],
"reference_brand": {
"advertiser_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"domain": "<string>",
"reviews_total": 0,
"reviews_classified": 0,
"reviews_examined": 0,
"reviews_unclassified": 0,
"reviews_not_examined": 0,
"reviews_no_aspect_found": 0,
"segment": "<string>",
"segment_source": "<string>",
"cells": [
{
"aspect": "<string>",
"mentions": 0,
"positive": 0,
"negative": 0,
"mixed": 0,
"neutral": 0,
"positive_pct": 50,
"negative_pct": 50,
"cohort_median_positive_pct": 50,
"cohort_median_negative_pct": 50,
"positive_delta_pp": 0,
"negative_delta_pp": 0,
"benchmark_brand_count": 0,
"not_measured_reason": "brand_not_classified",
"evidence": [
{
"review_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"sentiment": "positive",
"evidence": "<string>",
"evidence_rank": 2,
"platform": "<string>",
"source_url": "<string>",
"reviewer_name": "<string>",
"reviewed_at": "2023-11-07T05:31:56Z"
}
]
}
]
}
},
"findings": [
{
"rule_id": "<string>",
"module": "seo",
"panel": "<string>",
"title": "<string>",
"detail": "<string>",
"severity": "info",
"evidence_refs": [
"<string>"
]
}
],
"commentary": {
"module": "seo",
"group_key": "<string>",
"generated_at": "2023-11-07T05:31:56Z",
"period": "<string>",
"prompt_version": "<string>",
"schema_version": "<string>",
"status": "ready",
"summary": "",
"strengths": [
{
"title": "<string>",
"detail": "<string>",
"evidence_refs": [
"<string>"
],
"rule_id": "<string>",
"confidence": "medium"
}
],
"weaknesses": [
{
"title": "<string>",
"detail": "<string>",
"evidence_refs": [
"<string>"
],
"rule_id": "<string>",
"confidence": "medium"
}
],
"table_stakes": [
{
"title": "<string>",
"detail": "<string>",
"evidence_refs": [
"<string>"
],
"rule_id": "<string>",
"confidence": "medium"
}
],
"recommendations": [
{
"title": "<string>",
"detail": "<string>",
"evidence_refs": [
"<string>"
],
"rule_id": "<string>",
"confidence": "medium"
}
],
"source_refs": {},
"provenance": {},
"fallback_reason": "<string>",
"refresh_available_at": "2023-11-07T05:31:56Z"
}
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Brand Reviews
Review Brand Insights Route
The single-brand, single-platform aspect benchmark plus its narration.
The platform view’s Insights tab. Same measured grid the Brand Group tab renders, filtered to ONE advertiser on ONE platform — so every cohort field arrives nulled and no comparative rule can fire. The commentary rides the shared weekly cache under its own single-brand key.
A POST rather than a GET for the same reason every sibling commentary route is one: a cold cache enqueues a background generation, so the call is not side-effect-free even though its measured half is pure SQL.
Tenancy is enforced twice on purpose: _get_brand_or_404 for the owning
brand, and Brand Library visibility inside
get_advertiser_review_aspect_matrix for the advertiser being read. An
advertiser the caller cannot see resolves to no platform, which this route
then reports as “nothing collected” — never as a 403 that would confirm the
id exists.
POST
/
api
/
v1
/
brands
/
{brand_id}
/
brand-intelligence
/
review-brand-insights
Review Brand Insights Route
curl --request POST \
--url https://api.example.com/api/v1/brands/{brand_id}/brand-intelligence/review-brand-insights \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"advertiser_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"refresh": false
}
'import requests
url = "https://api.example.com/api/v1/brands/{brand_id}/brand-intelligence/review-brand-insights"
payload = {
"advertiser_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"refresh": False
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({advertiser_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a', refresh: false})
};
fetch('https://api.example.com/api/v1/brands/{brand_id}/brand-intelligence/review-brand-insights', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/api/v1/brands/{brand_id}/brand-intelligence/review-brand-insights",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'advertiser_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'refresh' => false
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/api/v1/brands/{brand_id}/brand-intelligence/review-brand-insights"
payload := strings.NewReader("{\n \"advertiser_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"refresh\": false\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/api/v1/brands/{brand_id}/brand-intelligence/review-brand-insights")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"advertiser_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"refresh\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v1/brands/{brand_id}/brand-intelligence/review-brand-insights")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"advertiser_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"refresh\": false\n}"
response = http.request(request)
puts response.read_body{
"advertiser_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"platform": "trustpilot",
"available_platforms": [
"trustpilot"
],
"aspect_matrix": {
"platform": "trustpilot",
"aspects": [
"<string>"
],
"aspect_slugs": [
"<string>"
],
"vocabulary_is_core_only": false,
"vocabulary_assumed": [
"<string>"
],
"vocabulary_mixed": [
"<string>"
],
"min_mentions": 0,
"brands_total": 0,
"brands_examined": 0,
"reviews_total": 0,
"reviews_classified_total": 0,
"reviews_examined_total": 0,
"basis_notice": "Computed over AITasker's depth-capped sample of collected reviews, and within that only the reviews we classified — not the platform's full review population. Unclassified and uncollected reviews are excluded from every figure rather than counted as zero.",
"rows": [
{
"advertiser_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"domain": "<string>",
"reviews_total": 0,
"reviews_classified": 0,
"reviews_examined": 0,
"reviews_unclassified": 0,
"reviews_not_examined": 0,
"reviews_no_aspect_found": 0,
"segment": "<string>",
"segment_source": "<string>",
"cells": [
{
"aspect": "<string>",
"mentions": 0,
"positive": 0,
"negative": 0,
"mixed": 0,
"neutral": 0,
"positive_pct": 50,
"negative_pct": 50,
"cohort_median_positive_pct": 50,
"cohort_median_negative_pct": 50,
"positive_delta_pp": 0,
"negative_delta_pp": 0,
"benchmark_brand_count": 0,
"not_measured_reason": "brand_not_classified",
"evidence": [
{
"review_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"sentiment": "positive",
"evidence": "<string>",
"evidence_rank": 2,
"platform": "<string>",
"source_url": "<string>",
"reviewer_name": "<string>",
"reviewed_at": "2023-11-07T05:31:56Z"
}
]
}
]
}
],
"reference_brand": {
"advertiser_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"domain": "<string>",
"reviews_total": 0,
"reviews_classified": 0,
"reviews_examined": 0,
"reviews_unclassified": 0,
"reviews_not_examined": 0,
"reviews_no_aspect_found": 0,
"segment": "<string>",
"segment_source": "<string>",
"cells": [
{
"aspect": "<string>",
"mentions": 0,
"positive": 0,
"negative": 0,
"mixed": 0,
"neutral": 0,
"positive_pct": 50,
"negative_pct": 50,
"cohort_median_positive_pct": 50,
"cohort_median_negative_pct": 50,
"positive_delta_pp": 0,
"negative_delta_pp": 0,
"benchmark_brand_count": 0,
"not_measured_reason": "brand_not_classified",
"evidence": [
{
"review_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"sentiment": "positive",
"evidence": "<string>",
"evidence_rank": 2,
"platform": "<string>",
"source_url": "<string>",
"reviewer_name": "<string>",
"reviewed_at": "2023-11-07T05:31:56Z"
}
]
}
]
}
},
"findings": [
{
"rule_id": "<string>",
"module": "seo",
"panel": "<string>",
"title": "<string>",
"detail": "<string>",
"severity": "info",
"evidence_refs": [
"<string>"
]
}
],
"commentary": {
"module": "seo",
"group_key": "<string>",
"generated_at": "2023-11-07T05:31:56Z",
"period": "<string>",
"prompt_version": "<string>",
"schema_version": "<string>",
"status": "ready",
"summary": "",
"strengths": [
{
"title": "<string>",
"detail": "<string>",
"evidence_refs": [
"<string>"
],
"rule_id": "<string>",
"confidence": "medium"
}
],
"weaknesses": [
{
"title": "<string>",
"detail": "<string>",
"evidence_refs": [
"<string>"
],
"rule_id": "<string>",
"confidence": "medium"
}
],
"table_stakes": [
{
"title": "<string>",
"detail": "<string>",
"evidence_refs": [
"<string>"
],
"rule_id": "<string>",
"confidence": "medium"
}
],
"recommendations": [
{
"title": "<string>",
"detail": "<string>",
"evidence_refs": [
"<string>"
],
"rule_id": "<string>",
"confidence": "medium"
}
],
"source_refs": {},
"provenance": {},
"fallback_reason": "<string>",
"refresh_available_at": "2023-11-07T05:31:56Z"
}
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Body
application/json
One brand, one platform — the platform view's Insights tab.
Deliberately NOT a subclass of BrandReviewGroupInsightsRequest: there
is no cohort, no reference brand and no group label here, and inheriting a
list of advertiser ids would let a caller widen a single-brand read into an
unbenchmarked cohort one.
Response
Successful Response
The single-brand aspect benchmark plus its narration.
aspect_matrix arrives with every cohort field nulled — a one-member
median is the subject compared with itself. commentary is the shared
weekly-cached module commentary scoped to this brand; it may be pending
on a cold cache, exactly like the cohort tab's.
Available options:
trustpilot, google Available options:
trustpilot, google The comparable grid, plus what stops it being over-read.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Was this page helpful?
⌘I