Огляд — Згадки

API + MCP

POST/v3/brand-radar/mentions-overview

Requests to this endpoint consume API units based on the prompts parameter: requests returning only custom prompt data are free, while requests including Ahrefs prompt data follow standard API unit pricing.

Every entity provided in brands (and competitors, when applicable) must include at least one value in names. Entities consisting only of url_groups are not supported here because mentions are matched against brand names.

Тіло запиту

whereobject

Вираз фільтра. Розпізнаються такі ідентифікатори стовпців (вони відрізняються від ідентифікаторів, які розпізнає параметр select).

selectarray<string>Required

Список полів для повернення.

Example:["field_a","field_b"]

tags_filterobject

Вираз фільтра для тегів підказки. Потрібен report_id. Використовує синтаксис фільтра з такими обмеженнями: єдина допустима назва поля — "tag"; єдині допустимі оператори: "eq", "neq", "substring", "isubstring", "phrase_match", "iphrase_match", "prefix", "suffix", "empty"; максимальна глибина вкладеності and, or — 2. Приклад: {"or": [{"field": "tag", "is": ["eq", "branded"]}, {"field": "tag", "is": ["eq", "competitor"]}]}.

countryarray<string>

Список дволітерних кодів країн (ISO 3166-1 alpha-2).

Allowed values:adaeafagaialamaoarasatauawazbabbbdbebfbgbhbibjbnbobrbsbtbwbybzcacdcfcgchcickclcmcncocrcucvcyczdedjdkdmdodzeceeegesetfifjfmfofrgagbgdgegfggghgiglgmgngpgqgrgtgugyhkhnhrhthuidieiliminiqisitjejmjojpkekgkhkiknkrkwkykzlalblclilklsltlulvlymamcmdmemgmkmlmmmnmqmrmsmtmumvmwmxmymznancnengninlnonpnrnunzompapepfpgphpkplpnprpsptpyqarerorsrurwsasbscsesgshsiskslsmsnsosrstsvtdtgthtjtktltmtntotrtttwtzuaugusuyuzvcvevgvivnvuwsyeytzazmzw

Default:

report_idstring

ID звіту, який потрібно використати. Якщо його задано, інші параметри беруться зі звіту (бренд, конкуренти, ринок, країна, фільтри). Якщо задано країну або фільтри, вони замінюють значення зі звіту. Його можна знайти в URL вашого звіту Brand Radar в Ahrefs: https://app.ahrefs.com/brand-radar/reports/#report_id#/...

promptsstring

Тип запитів, які потрібно використовувати. Якщо не вказано, буде використано обидва типи. Користувацькі запити потребують вказаного report_id.

Allowed values:ahrefscustom

data_sourcearray<string>Required

Список моделей чатботів. Моделі ключових слів Google (google_ai_overviews_keywords, google_ai_mode_keywords) не можна поєднувати між собою або з іншими моделями.

Allowed values:chatgptgoogle_ai_overviewsgoogle_ai_modegeminiperplexitycopilotgrokgoogle_ai_overviews_keywordsgoogle_ai_mode_keywords

marketarray<string>

Список нішевих ринків ваших брендів. Застаріє 18.05.2026 — після цієї дати параметр більше не матиме жодного ефекту.

competitorsarray<object>

Список назв і вебсайтів конкурентів для пошуку.

At least one of names or url_groups is required

namesarray<string>

Назви бренду/конкурента.

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

url_groupsarray<object>

targetstring (domain)required

Домен цілі.

Example:ahrefs.com

scopestringrequired

Область застосування цілі.

Allowed values:urlpathdomainsubdomains

brandsarray<object>

Список назв і вебсайтів брендів для пошуку.

At least one of names or url_groups is required

namesarray<string>

Назви бренду/конкурента.

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

url_groupsarray<object>

targetstring (domain)required

Домен цілі.

Example:ahrefs.com

scopestringrequired

Область застосування цілі.

Allowed values:urlpathdomainsubdomains

outputstring

Формат виводу.

Allowed values:jsoncsvxmlphp

Відповіді

metricsarray<object>

brandstring

Назва бренду (ваш бренд або конкурент, зазначений у запиті).

no_tracked_brandsinteger

Орієнтовна кількість згадок із відповідей, пов’язаних із зазначеним ринком, у яких не згадується жоден із наданих брендів (значення дорівнює нулю, якщо market не вказано).

only_competitors_brandsinteger

Орієнтовна кількість згадок із відповідей, у яких згадуються лише бренди конкурентів.

only_target_brandinteger

Орієнтовна кількість згадок із відповідей, у яких згадується лише ваш бренд.

target_and_competitors_brandsinteger

Орієнтовна кількість згадок із відповідей, у яких згадуються і ваш бренд, і бренди конкурентів.

totalinteger

Загальна орієнтовна кількість згадок для вашого бренду (включає only_target_brand і target_and_competitors_brands).