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

Огляд історії цитувань

Лише API
POST/v3/brand-radar/citations-history

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

Кожна сутність, передана в brands (а також у competitors, якщо застосовно), має містити принаймні одне значення в url_groups. Сутності, що складаються лише з names, тут не підтримуються, оскільки цитування зіставляються з групами URL.

Тіло запиту

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"]}]}
date_tostring (date)

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

date_fromstring (date)Required

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

search_volume_typestring

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

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

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

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

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

promptsstring

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

Дозволені значення:ahrefscustom
data_sourcearray<string>Required

Список моделей чатботів. Усі моделі можна поєднувати між собою. Модуль claude підтримує лише користувацькі запити.

Дозволені значення:chatgptgoogle_ai_overviewsgoogle_ai_modegeminiperplexitycopilotclaudegrokgoogle_ai_overviews_keywordsgoogle_ai_mode_keywords
marketarray<string>

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

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>
citationsinteger

Оцінка кількості цитувань у відповідях, у яких згадано URL-адреси бренду.

datestring (date)