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

Огляд — Частка голосу

API + MCP
POST/v3/brand-radar/sov-overview

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

Тіло запиту

whereobject

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

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

Звіти з видимості ШІ переходять на обсяг із поправкою на ШІ. Він точніше оцінює попит на відповіді ШІ в різних чатботах і пошукових сервісах зі ШІ. Його обчислюють, коригуючи обсяг пошуку Google з урахуванням оціненого використання кожної ШІ-платформи порівняно з Google. Цей параметр застаріє 30 вересня 2026 року; усі запити використовуватимуть новий обсяг із поправкою на ШІ.

Дозволені значення:ask_volumekeyword_volume
Default:ask_volume
countryarray<string>

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

Дозволені значення:adaeafagaialamaoarasatauawazba…
Default:[]
report_idstring

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

promptsstring

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

Дозволені значення:ahrefscustom
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
marketarray<string>

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

Хв:1
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
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
outputstring

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

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

Відповіді

metricsarray<object>
brandstring

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

share_of_voicenumber (float)

Орієнтовна частка голосу для вашого бренду.