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

Додати звіти Brand Radar

API + MCP
POST/v3/management/brand-radar-reports

Запити до цього ендпоїнта безкоштовні та не витрачають жодних одиниць API.

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

outputstring

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

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

Тіло запиту

brand

Щонайменше одне з полів brand або competitors має бути непорожнім.

Рекомендовано. Можна вказати назви брендів і групи URL-адрес для точного таргетингу.

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
competitors

Щонайменше одне з полів brand або competitors має бути непорожнім.

Рекомендовано. Можна вказати назви брендів і групи URL-адрес для точного таргетингу.

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
namestring

Назва звіту.

project_idinteger

ID проєкту для використання.

content_filterobject

Необов’язкові фрази, які використовуються для включення або виключення результатів залежно від їхнього вмісту.

includearray<string>

Показувати лише результати, що містять принаймні одну з цих точних фраз.

excludearray<string>

Приховувати результати, що містять будь-яку з цих точних фраз.

prompts_frequencyarray<object>

Частота використання запитів.

Хв:1
data_sourcestringrequired

Джерело даних, яке слід використовувати.

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

Інтервал оновлення, який слід використовувати.

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

Відповіді

reportsarray<object>
created_atstring (date)

Дата створення звіту.

project_idinteger or null

ID проєкту, до якого прив'язаний звіт.

prompts_frequencyarray<object>

Запис із полями data_source (можливі значення: chatgpt, copilot, gemini, google_ai_mode, claude, google_ai_overviews, grok, perplexity) і frequency (можливі значення: daily, weekly, monthly, off).

data_sourcestring
frequencystring
report_idstring

Унікальний ідентифікатор звіту.

report_namestring

Назва звіту.