Теми

API + MCPЛише для Enterprise

POST/v3/brand-radar/topics

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

Тіло запиту

selectarray<string>Required

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

Доступні поля:

country
mentions
responses
topic
volume

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

limitinteger

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

Default:1000

datestring (date)

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

date_fromstring (date)

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

date_tostring (date)

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

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

brand_filterobject

Вираз фільтрації для видимості вашого бренду, що повторює фільтр “Ваш бренд”. brand_name визначає, чи згадується ваш бренд у відповіді: "mentioned" або "not_mentioned". page_status визначає, як ШІ використав ваші сторінки: "cited" (ШІ знайшов сторінки вашого сайту та послався на них у відповіді), "found_but_not_cited" (ШІ знайшов сторінки вашого сайту як потенційні джерела, але не послався на них в остаточній відповіді) або "not_found" (ШІ не знайшов жодної сторінки вашого сайту).
Використовує синтаксис фільтрів з такими обмеженнями: єдиний допустимий оператор — "eq"; кожне поле є окремим розділом: укажіть одне значення або об’єднайте кілька значень одного й того самого поля через or; розділи brand_name і page_status поєднуйте на верхньому рівні через and/or. Вибір усіх значень поля відхиляється, оскільки такий фільтр збігається з усім (натомість не вказуйте це поле).

Example:{"and":[{"field":"brand_name","is":["eq","mentioned"]},{"or":[{"field":"page_status","is":["eq","cited"]},{"field":"page_status","is":["eq","found_but_not_cited"]}]}]}

volume_rangeobject

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

frominteger

tointeger

outputstring

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

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

Відповіді

topicsarray<object>

countrystring

Країна, пов’язана з темою. Якщо основну тему не визначено, це єдина вибрана країна або all, якщо вибрано кілька країн чи всі країни.

mentionsarray<object>

Кількість відповідей для відстежуваного бренду та кожного конкурента.

entitystring

Відстежуваний бренд або конкурент.

responsesinteger

Кількість відповідей ШІ, у яких згадується сутність.

responsesinteger

Кількість відповідей ШІ, пов’язаних із темою.

topicstring or null

Основна тема. Null, якщо основну тему не визначено.

volumeinteger or null

Орієнтовний щомісячний обсяг пошуку для теми.