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

API + MCP

POST/v3/brand-radar/sov-overview

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

Тіло запиту

whereobject

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

cited_domain: Домен сторінки, яку було використано для формування відповіді.
тип: домен

cited_domain_subdomains: Домен сторінки, яку було використано для формування відповіді. Також збігатиметься будь-який піддомен заданого домену.
тип: рядок

cited_url_exact: URL сторінки, яку було використано для формування відповіді.
тип: рядок

cited_url_prefix: URL сторінки, яку було використано для формування відповіді. Збігатиметься будь-який URL, що починається з цього префікса.
тип: рядок

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

response (10 одиниць): Відповідь моделі.
тип: рядок

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

topic: Тема запиту.
тип: рядок

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

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, google_ai_mode) не можна поєднувати між собою або з моделями не від Google.

Allowed values:google_ai_overviewsgoogle_ai_modechatgptgeminiperplexitycopilotgrok

marketarray<string>

Список нішевих ринків ваших брендів.

competitorsarray<object>

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

At least one of names or url_groups is required

namesarray<string>

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

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

url_groupsarray<object>

targetstringrequired

Домен цілі.

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>

targetstringrequired

Домен цілі.

Example:ahrefs.com

scopestringrequired

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

Allowed values:urlpathdomainsubdomains

outputstring

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

Allowed values:jsoncsvxmlphp

Відповіді

metricsarray<object>

brandstring

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

share_of_voicenumber

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