Przegląd – Wzmianki

API + MCP

POST/v3/brand-radar/mentions-overview

Żądania kierowane do tego punktu końcowego zużywają jednostki API w zależności od parametru prompts: żądania zwracające wyłącznie dane niestandardowych promptów są bezpłatne, natomiast żądania zawierające dane promptów Ahrefs są rozliczane zgodnie ze standardowym cennikiem jednostek API.

Każdy podmiot podany w brands (oraz w competitors, gdy ma to zastosowanie) musi zawierać co najmniej jedną wartość w names. Podmioty składające się wyłącznie z url_groups nie są tutaj obsługiwane, ponieważ wzmianki są dopasowywane do nazw marek.

Treść żądania

whereobject

Wyrażenie filtra. Rozpoznawane są następujące identyfikatory kolumn (różnią się one od identyfikatorów rozpoznawanych przez parametr select).

selectarray<string>Required

Lista pól zwracanych w odpowiedzi.

Example:["field_a","field_b"]

tags_filterobject

Wyrażenie filtra dla tagów promptu. Wymaga report_id. Używa składni filtrów z następującymi ograniczeniami: jedyną prawidłową nazwą pola jest "tag"; jedynymi prawidłowymi operatorami są: "eq", "neq", "substring", "isubstring", "phrase_match", "iphrase_match", "prefix", "suffix", "empty"; maksymalna głębokość zagnieżdżenia and oraz or wynosi 2. Przykład: {"or": [{"field": "tag", "is": ["eq", "branded"]}, {"field": "tag", "is": ["eq", "competitor"]}]}.

countryarray<string>

Lista dwuliterowych kodów krajów (ISO 3166-1 alpha-2).

Allowed values:adaeafagaialamaoarasatauawazbabbbdbebfbgbhbibjbnbobrbsbtbwbybzcacdcfcgchcickclcmcncocrcucvcyczdedjdkdmdodzeceeegesetfifjfmfofrgagbgdgegfggghgiglgmgngpgqgrgtgugyhkhnhrhthuidieiliminiqisitjejmjojpkekgkhkiknkrkwkykzlalblclilklsltlulvlymamcmdmemgmkmlmmmnmqmrmsmtmumvmwmxmymznancnengninlnonpnrnunzompapepfpgphpkplpnprpsptpyqarerorsrurwsasbscsesgshsiskslsmsnsosrstsvtdtgthtjtktltmtntotrtttwtzuaugusuyuzvcvevgvivnvuwsyeytzazmzw

Default:

report_idstring

Identyfikator raportu, którego należy użyć. Jeśli zostanie podany, pozostałe parametry są pobierane z raportu (marka, konkurenci, rynek, kraj, filtry). Jeśli podasz kraj lub filtry, zastąpią one wartości z raportu. Znajdziesz go w adresie URL raportu Brand Radar w Ahrefs: https://app.ahrefs.com/brand-radar/reports/#report_id#/...

promptsstring

Typ promptów, których należy użyć. Jeśli nie zostanie określony, użyte zostaną oba. Niestandardowe prompty wymagają podania report_id.

Allowed values:ahrefscustom

data_sourcearray<string>Required

Lista modeli chatbotów. Modele słów kluczowych Google (google_ai_overviews_keywords, google_ai_mode_keywords) nie mogą być łączone ze sobą ani z innymi modelami.

Allowed values:chatgptgoogle_ai_overviewsgoogle_ai_modegeminiperplexitycopilotgrokgoogle_ai_overviews_keywordsgoogle_ai_mode_keywords

marketarray<string>

Lista rynków niszowych Twoich marek. Wycofane od 2026-05-18; krótko po tej dacie ten parametr przestanie działać.

competitorsarray<object>

Lista nazw konkurentów i stron internetowych do wyszukania.

Default:

At least one of names or url_groups is required

namesarray<string>

Nazwy marki/konkurenta

Example:["ahrefs","ahrefs seo"]

url_groupsarray<object>

targetstring (domain)required

Domena celu

Example:ahrefs.com

scopestringrequired

Zakres celu.

Allowed values:urlpathdomainsubdomains

brandsarray<object>

Lista nazw marek i stron internetowych do wyszukania.

Default:

At least one of names or url_groups is required

namesarray<string>

Nazwy marki/konkurenta

Example:["ahrefs","ahrefs seo"]

url_groupsarray<object>

targetstring (domain)required

Domena celu

Example:ahrefs.com

scopestringrequired

Zakres celu.

Allowed values:urlpathdomainsubdomains

outputstring

Format wyjściowy.

Allowed values:jsoncsvxmlphp

Odpowiedzi

metricsarray<object>

brandstring

Nazwa marki (Twojej lub konkurenta podanego w żądaniu).

no_tracked_brandsinteger

Szacowana liczba wzmianek na podstawie odpowiedzi związanych z określonym rynkiem, w których nie wspomniano żadnej z podanych marek (wartość wynosi zero, gdy market nie jest określony).

only_competitors_brandsinteger

Szacowana liczba wzmianek na podstawie odpowiedzi, w których wspomniano wyłącznie marki konkurencji.

only_target_brandinteger

Szacowana liczba wzmianek na podstawie odpowiedzi, w których wspomniano wyłącznie Twoją markę.

target_and_competitors_brandsinteger

Szacowana liczba wzmianek na podstawie odpowiedzi, w których wspomniano zarówno Twoją markę, jak i marki konkurencji.

totalinteger

Łączna szacowana liczba wzmianek dla Twojej marki (obejmuje zarówno only_target_brand, jak i target_and_competitors_brands).

curl "https://api.ahrefs.com/v3/brand-radar/mentions-overview" \ -X POST \ -H "Authorization: Bearer $AHREFS_API_KEY" \ -H "Accept: application/json" \ -H "Content-Type: application/json" \ --data-raw '{ "where": {}, "select": ["field_a","field_b"], "tags_filter": {}, "country": ["ad"], "report_id": "string", "prompts": "ahrefs", "data_source": ["chatgpt"], "market": ["string"], "competitors": [ { "names": ["ahrefs","ahrefs seo"], "url_groups": [ { "target": "ahrefs.com", "scope": "url" } ] } ], "brands": [ { "names": ["ahrefs","ahrefs seo"], "url_groups": [ { "target": "ahrefs.com", "scope": "url" } ] } ], "output": "json" }'

{ "metrics": [ { "brand": "string", "no_tracked_brands": 0, "only_competitors_brands": 0, "only_target_brand": 0, "target_and_competitors_brands": 0, "total": 0 } ] }