Refresh Brand Intelligence Watchlist Route
curl --request POST \
--url https://api.example.com/api/v1/brands/{brand_id}/brand-intelligence/refresh \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"provider": "meta_official",
"watchlist_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"advertiser_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"country": "<string>",
"platform": "<string>",
"limit": 20
}
'import requests
url = "https://api.example.com/api/v1/brands/{brand_id}/brand-intelligence/refresh"
payload = {
"provider": "meta_official",
"watchlist_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"advertiser_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"country": "<string>",
"platform": "<string>",
"limit": 20
}
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({
provider: 'meta_official',
watchlist_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
advertiser_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
country: '<string>',
platform: '<string>',
limit: 20
})
};
fetch('https://api.example.com/api/v1/brands/{brand_id}/brand-intelligence/refresh', 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/refresh",
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([
'provider' => 'meta_official',
'watchlist_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'advertiser_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'country' => '<string>',
'platform' => '<string>',
'limit' => 20
]),
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/refresh"
payload := strings.NewReader("{\n \"provider\": \"meta_official\",\n \"watchlist_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"advertiser_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"country\": \"<string>\",\n \"platform\": \"<string>\",\n \"limit\": 20\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/refresh")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"provider\": \"meta_official\",\n \"watchlist_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"advertiser_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"country\": \"<string>\",\n \"platform\": \"<string>\",\n \"limit\": 20\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v1/brands/{brand_id}/brand-intelligence/refresh")
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 \"provider\": \"meta_official\",\n \"watchlist_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"advertiser_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"country\": \"<string>\",\n \"platform\": \"<string>\",\n \"limit\": 20\n}"
response = http.request(request)
puts response.read_body{
"brand_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"requested_at": "2023-11-07T05:31:56Z",
"provider": "<string>",
"limit": 123,
"country": "<string>",
"platform": "<string>",
"enqueued": 0,
"skipped": 0,
"already_running": 0,
"jobs": [
{
"job_id": "<string>",
"watchlist_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"watchlist_item_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"advertiser_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"source_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"advertiser_name": "<string>",
"advertiser_domain": "<string>",
"provider": "<string>",
"country": "<string>",
"already_running": false
}
],
"skipped_items": [
{
"watchlist_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"watchlist_item_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"advertiser_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"reason": "<string>",
"source_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"provider": "<string>",
"country": "<string>"
}
]
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Brand Intelligence
Refresh Brand Intelligence Watchlist Route
Enqueue public-ad ingestion for a brand’s watched advertisers.
Guardrails (2026-07-05 Metapi-burn incident): every provider fetch spends
credits even when every returned ad is already in the library, so
user-initiated refreshes are throttled per brand
(brand_intel_refresh_min_interval_hours), capped per advertiser
(brand_intel_refresh_tracked_limit), and scoped to advertisers still
tracked by a live competitor. Admins (ADMIN_EMAILS) bypass all three; bulk
library freshness is the nightly cron’s job
(scripts/nightly_ad_library_refresh.py).
POST
/
api
/
v1
/
brands
/
{brand_id}
/
brand-intelligence
/
refresh
Refresh Brand Intelligence Watchlist Route
curl --request POST \
--url https://api.example.com/api/v1/brands/{brand_id}/brand-intelligence/refresh \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"provider": "meta_official",
"watchlist_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"advertiser_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"country": "<string>",
"platform": "<string>",
"limit": 20
}
'import requests
url = "https://api.example.com/api/v1/brands/{brand_id}/brand-intelligence/refresh"
payload = {
"provider": "meta_official",
"watchlist_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"advertiser_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"country": "<string>",
"platform": "<string>",
"limit": 20
}
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({
provider: 'meta_official',
watchlist_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
advertiser_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
country: '<string>',
platform: '<string>',
limit: 20
})
};
fetch('https://api.example.com/api/v1/brands/{brand_id}/brand-intelligence/refresh', 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/refresh",
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([
'provider' => 'meta_official',
'watchlist_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'advertiser_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'country' => '<string>',
'platform' => '<string>',
'limit' => 20
]),
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/refresh"
payload := strings.NewReader("{\n \"provider\": \"meta_official\",\n \"watchlist_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"advertiser_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"country\": \"<string>\",\n \"platform\": \"<string>\",\n \"limit\": 20\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/refresh")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"provider\": \"meta_official\",\n \"watchlist_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"advertiser_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"country\": \"<string>\",\n \"platform\": \"<string>\",\n \"limit\": 20\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v1/brands/{brand_id}/brand-intelligence/refresh")
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 \"provider\": \"meta_official\",\n \"watchlist_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"advertiser_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"country\": \"<string>\",\n \"platform\": \"<string>\",\n \"limit\": 20\n}"
response = http.request(request)
puts response.read_body{
"brand_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"requested_at": "2023-11-07T05:31:56Z",
"provider": "<string>",
"limit": 123,
"country": "<string>",
"platform": "<string>",
"enqueued": 0,
"skipped": 0,
"already_running": 0,
"jobs": [
{
"job_id": "<string>",
"watchlist_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"watchlist_item_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"advertiser_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"source_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"advertiser_name": "<string>",
"advertiser_domain": "<string>",
"provider": "<string>",
"country": "<string>",
"already_running": false
}
],
"skipped_items": [
{
"watchlist_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"watchlist_item_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"advertiser_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"reason": "<string>",
"source_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"provider": "<string>",
"country": "<string>"
}
]
}{
"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
Response
Successful Response
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Was this page helpful?
⌘I