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

Згадування

API + MCP
POST/v3/brand-radar/citations-history

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

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

Тіло запиту

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
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
date_fromstring (date)Required

Початкова дата історичного періоду у форматі 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" ] } ] }
outputstring

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

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

Відповіді

metricsarray<object>
citationsinteger

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

datestring (date)