Docs
Szukaj w dokumentacji...⌘K

Dodaj raporty Brand Radar

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

Żądania do tego punktu końcowego są bezpłatne i nie zużywają żadnych jednostek API.

Parametry zapytania

outputstring

Format wyjściowy.

Dozwolone wartości:jsonphp

Treść żądania

brand

Co najmniej jedno z pól brand lub competitors musi być niepuste.

Zalecane. Umożliwia podanie nazw marek i grup adresów URL w celu precyzyjnego targetowania.

At least one of names or url_groups is required
namesarray<string>

Nazwy marki/konkurenta

Example:["ahrefs","ahrefs seo"]
url_groupsarray<object>
targetstring (domain)required

Domena celu

Example:ahrefs.com
scopestringrequired

Zakres celu.

Dozwolone wartości:urlpathdomainsubdomains
competitors

Co najmniej jedno z pól brand lub competitors musi być niepuste.

Zalecane. Umożliwia podanie nazw marek i grup adresów URL w celu precyzyjnego targetowania.

At least one of names or url_groups is required
namesarray<string>

Nazwy marki/konkurenta

Example:["ahrefs","ahrefs seo"]
url_groupsarray<object>
targetstring (domain)required

Domena celu

Example:ahrefs.com
scopestringrequired

Zakres celu.

Dozwolone wartości:urlpathdomainsubdomains
namestring

Nazwa raportu.

project_idinteger

Identyfikator projektu do użycia.

content_filterobject

Opcjonalne frazy służące do uwzględniania lub wykluczania wyników na podstawie ich treści.

includearray<string>

Wyświetlaj tylko wyniki zawierające co najmniej jedną z tych dokładnych fraz.

excludearray<string>

Ukrywaj wyniki zawierające dowolną z tych dokładnych fraz.

prompts_frequencyarray<object>

Częstotliwość promptów do użycia.

Min.:1
data_sourcestringrequired

Źródło danych, którego należy użyć.

Dozwolone wartości:chatgptgoogle_ai_overviewsgoogle_ai_modegeminiperplexitycopilotclaudegrok
frequencystringrequired

Interwał aktualizacji, którego należy użyć.

Dozwolone wartości:dailyweeklymonthlyoff

Odpowiedzi

reportsarray<object>
created_atstring (date)

Data utworzenia raportu.

project_idinteger or null

Identyfikator projektu, z którym powiązany jest raport.

prompts_frequencyarray<object>

Rekord zawierający pola data_source (możliwe wartości: chatgpt, copilot, gemini, google_ai_mode, claude, google_ai_overviews, grok, perplexity) oraz frequency (możliwe wartości: daily, weekly, monthly, off).

data_sourcestring
frequencystring
report_idstring

Unikatowy identyfikator raportu.

report_namestring

Nazwa raportu.