Історія огляду — Частка голосу

API + MCP

GET/v3/brand-radar/sov-history

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

Параметри запиту

wherestring

Вираз фільтра. Розпізнаються такі ідентифікатори стовпців (це відрізняється від ідентифікаторів, які розпізнає параметр 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: Тема запиту.
тип: рядок

date_tostring

Кінцева дата історичного періоду у форматі YYYY-MM-DD.

date_fromstringОбов’язково

Початкова дата історичного періоду у форматі YYYY-MM-DD.

countrystring

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

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

report_idstring

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

promptsstring

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

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

data_sourcestringОбов’язково

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

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

Example:chatgpt,perplexity

marketstring

Список нішевих ринків ваших брендів, розділений комами.

competitorsstring

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

brandstring

Список брендів для пошуку, розділений комами. Принаймні одне з полів brand, competitors, market або where не повинно бути порожнім.

outputstring

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

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

Відповіді

metricsarray<object>

datestring

share_of_voicearray<object>

(1 одиниця на бренд) Оціночна частка голосу бренду.