Згадування

API + MCP

POST/v3/brand-radar/mentions-overview

Запити до цього ендпойнта витрачають API-одиниці залежно від параметра prompts: запити, які повертають лише дані користувацьких запитів, є безкоштовними, тоді як запити, що містять дані запитів Ahrefs, тарифікуються за стандартними розцінками в API-одиницях.

Кожна сутність, указана в brands (а також у competitors, якщо застосовно), має містити принаймні одне значення в names. Сутності, що складаються лише з url_groups, тут не підтримуються, оскільки згадки зіставляються з назвами брендів.

Тіло запиту

selectarray<string>Required

Список полів, які потрібно повернути.

Example:["field_a","field_b"]

whereobject

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

report_idstring

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

brandsarray<object>

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

Default:[]

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

Область дії цілі.

Дозволені значення:urlpathdomainsubdomains

competitorsarray<object>

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

Default:[]

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

Область дії цілі.

Дозволені значення:urlpathdomainsubdomains

content_filterobject

Необов’язкові фрази, які використовуються для включення або виключення результатів залежно від їхнього вмісту.

includearray<string>

Показувати лише результати, що містять принаймні одну з цих точних фраз.

excludearray<string>

Приховувати результати, що містять будь-яку з цих точних фраз.

data_sourcearray<string>Required

Список моделей чатботів. Усі моделі можна поєднувати між собою. Модуль claude підтримує лише користувацькі запити.
Моделі google_ai_overviews_keywords і google_ai_mode_keywords надають дані про видимість в Оглядах від ШІ / режимі ШІ, визначену на основі пошукових запитів Google (ключових слів), а не запитів до моделей.

Дозволені значення:chatgptgoogle_ai_overviewsgoogle_ai_modegeminiperplexitycopilotclaudegrokgoogle_ai_overviews_keywordsgoogle_ai_mode_keywords

countryarray<string>

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

Дозволені значення:adaeafagaialamaoarasatauawazba…

Default:[]

promptsstring

Тип запитів, які слід використовувати. Якщо не вказано, використовуватимуться обидва. Для користувацьких запитів потрібно вказати report_id.

Дозволені значення:ahrefscustom

tags_filterobject

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

Example:{"or":[{"field":"tag","is":["eq","branded"]},{"field":"tag","is":["eq","competitor"]}]}

outputstring

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

Дозволені значення:jsoncsvxmlphp

Відповіді

metricsarray<object>

brandstring

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

entity_typestring

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

Дозволені значення:aggregatetargetcompetitor

no_tracked_brandsinteger

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

only_competitors_brandsinteger

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

only_target_brandinteger

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

target_and_competitors_brandsinteger

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

totalinteger

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