Docs
Пошук документації...⌘K

Відповіді ШІ

API + MCP
POST/v3/brand-radar/ai-responses

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

Тіло запиту

volume_rangeobject

Діапазон обсягу для фільтрації.

frominteger
tointeger
selectarray<string>Required

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

Example:["field_a","field_b"]
whereobject

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

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"]}]}.

limitinteger

Кількість результатів, які потрібно повернути.

Default:1000
datestring (date)

Дата для пошуку у форматі YYYY-MM-DD.

countryarray<string>

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

Allowed values:adaeafagaialamaoarasatauawazbabbbdbebfbgbhbibjbnbobrbsbtbwbybzcacdcfcgchcickclcmcncocrcucvcyczdedjdkdmdodzeceeegesetfifjfmfofrgagbgdgegfggghgiglgmgngpgqgrgtgugyhkhnhrhthuidieiliminiqisitjejmjojpkekgkhkiknkrkwkykzlalblclilklsltlulvlymamcmdmemgmkmlmmmnmqmrmsmtmumvmwmxmymznancnengninlnonpnrnunzompapepfpgphpkplpnprpsptpyqarerorsrurwsasbscsesgshsiskslsmsnsosrstsvtdtgthtjtktltmtntotrtttwtzuaugusuyuzvcvevgvivnvuwsyeytzazmzw
Default:
order_bystring

Стовпець, за яким потрібно впорядкувати результати.

Allowed values:relevancevolume
Default:relevance
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>

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

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

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

Allowed values:urlpathdomainsubdomains
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

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

Allowed values:urlpathdomainsubdomains
outputstring

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

Allowed values:jsonphp

Відповіді

ai_responsesarray<object>
countrystring

Країна запитання.

data_sourcestring

Модель чатбота, яка згенерувала відповідь.

last_updatedstring (date)

Дата останнього оновлення даних.

linksarray<object>

(10 одиниць) Посилання, використані для відповіді.

urlstring
titlestring or null
questionstring

Запитання, поставлене користувачем.

responsestring

(10 одиниць) Відповідь моделі.

search_queriesarray<string>

Пошуковий запит, який чатбот використовує, щоб знайти інформацію для відповіді. Примітка: якщо data_source не містить chatgpt або perplexity, це поле завжди буде порожнім.

tagsarray<string>

Теги, призначені запиту.

volumeinteger

(10 одиниць) Орієнтовний місячний обсяг пошуку. Це базується на наших оцінках для Google й поєднує обсяги пошуку пов'язаних ключових слів, у яких це запитання з'являється в розділі People Also Ask.