Belgeler
Ctrl+K Arama Alt+[Alt+] Kılavuzlar
API anahtarını al

API · Markalar

Markalar ve Marka Takibi

GET /api/v1/markalar is the API-key tracked-brands list (metered). Brand detail tabs use /api/markalar/* in a logged-in browser session — they are not available over an API key. MCP equivalent: list_tracked_brands.

AL/api/v1/markalar

List the brands tracked by the API key owner.

Send X-API-Anahtarı on every request.

Query parameters

  • sıralamadizeoptional

    Order of the returned list.

    Varsayılan date_added·Values date_added ad new_ads growth
  • aramadizeoptional

    Case-insensitive match on brand name or page id.

  • board_iddizeoptional

    Only brands on that saved board (must belong to the user).

Talep
curl -sS \
  -H "X-API-Key: $WH_API_KEY" \
  "{origin}/api/v1/brands?sort=date_added&search=string&board_id=string"
const res = await fetch(`${ORIGIN}/api/v1/brands?sort=date_added&search=string&board_id=string`, {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.WH_API_KEY,
  },
});
const data = await res.json();
import os, requests

res = requests.get(
    f"{ORIGIN}/api/v1/brands?sort=date_added&search=string&board_id=string",
    headers={"X-API-Key": os.environ["WH_API_KEY"]},
)
data = res.json()
Yanıt
[
    {
        "id": "108897621643793",
        "name": "Allbirds",
        "logo_url": "https://cdn.example.com/brands/allbirds.png",
        "page_url": "https://www.facebook.com/allbirds",
        "status": "active",
        "total_ads": 412,
        "active_ads_on_page": 142,
        "new_ads_count": 18,
        "new_ads_change": 0.14,
        "added_at": "2024-04-12"
    }
]
{
    "success": false,
    "error": "Unauthorized"
}
{
    "success": false,
    "error": "WinningHunter Standard subscription required"
}

The tracked-brands list is returned as a JSON array (not wrapped in { success, data }).

Brand detail (session only)

These power the Brand tracker UI and require a logged-in browser session, not an API key. The brand identifier (id) is the Facebook page_id from the list above.

Method Yol Body / params Amaç
YAYIN /api/brands/follow url (ad library URL) Track a brand.
YAYIN /api/brands/unfollow page_id Remove a tracked brand.
AL /api/brands/amount-tracked — Tracked count + plan cap.
AL /api/markalar/reklamlar id, sayfa (0-based, 12/page), tarih aralığı Paginated ads for one brand.

Date range filter

tarih aralığı applies to /api/markalar/reklamlar and other insight tabs:

Değer Anlamı
(absent) / hepsi No date filter
canlı Last seen in the last 3 days
7d, 30d, 3m, 6m Ad start date on or after the rolling cutoff
özel Requires başlangıç tarihi ve bitiş tarihi (A-G-Y)