curl --request POST \
--url https://api.example.com/api/v1/brands/{brand_id}/brand-intelligence/brand-insights/commentary \
--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/brand-insights/commentary"
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/brand-insights/commentary', 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/brand-insights/commentary",
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/brand-insights/commentary"
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/brand-insights/commentary")
.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/brand-insights/commentary")
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{
"group_key": "<string>",
"generated_at": "2023-11-07T05:31:56Z",
"period": "<string>",
"prompt_version": "<string>",
"schema_version": "<string>",
"status": "ready",
"summary": "",
"weekly": [
{
"title": "<string>",
"detail": "<string>",
"evidence_refs": [
"<string>"
],
"confidence": "medium"
}
],
"monthly": [
{
"title": "<string>",
"detail": "<string>",
"evidence_refs": [
"<string>"
],
"confidence": "medium"
}
],
"recommendations": [
{
"title": "<string>",
"detail": "<string>",
"evidence_refs": [
"<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": {}
}
]
}Get Brand Intelligence Brand Digest Route
Weekly AI digest for ONE advertiser — the Brand Details Overview card.
The group-commentary machinery with a single-brand subject
(subject_kind='brand', own brand-intel:brand-commentary: cache
namespace). First view of a week queues a background generation and
returns a pending placeholder; refresh=true re-queues at most once per
24h (server-enforced cooldown).
The advertiser is caller-supplied and only has to be VISIBLE to the
caller — and visible_to_caller_predicate’s owns arm makes the
caller’s own advertiser visible — so the subject may be the user’s own
brand. That case takes subject_kind='own-brand' (own prompt, own
brand-intel:own-brand-commentary: namespace); otherwise the prose
describes the reader to themselves in the third person and draws
“implications for the user’s brand” from the user’s own brand.
curl --request POST \
--url https://api.example.com/api/v1/brands/{brand_id}/brand-intelligence/brand-insights/commentary \
--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/brand-insights/commentary"
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/brand-insights/commentary', 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/brand-insights/commentary",
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/brand-insights/commentary"
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/brand-insights/commentary")
.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/brand-insights/commentary")
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{
"group_key": "<string>",
"generated_at": "2023-11-07T05:31:56Z",
"period": "<string>",
"prompt_version": "<string>",
"schema_version": "<string>",
"status": "ready",
"summary": "",
"weekly": [
{
"title": "<string>",
"detail": "<string>",
"evidence_refs": [
"<string>"
],
"confidence": "medium"
}
],
"monthly": [
{
"title": "<string>",
"detail": "<string>",
"evidence_refs": [
"<string>"
],
"confidence": "medium"
}
],
"recommendations": [
{
"title": "<string>",
"detail": "<string>",
"evidence_refs": [
"<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
Response
Successful Response
ready, pending 6006Show child attributes
Show child attributes
6Show child attributes
Show child attributes
6Show child attributes
Show child attributes
Show child attributes
Show child attributes
Was this page helpful?