Docs
Szukaj w dokumentacji...⌘K

Tematy

API + MCPTylko Enterprise
POST/v3/brand-radar/topics

Żądania do tego punktu końcowego zużywają jednostki API w zależności od parametru prompts: żądania zwracające wyłącznie dane niestandardowego promptu są bezpłatne, natomiast żądania uwzględniające dane promptów Ahrefs są rozliczane zgodnie ze standardowym cennikiem jednostek API.

Treść żądania

selectarray<string>Required

Lista pól do zwrócenia.

Dostępne pola:
  • country
  • mentions
  • responses
  • topic
  • volume
Example:["field_a","field_b"]
whereobject

Wyrażenie filtra. Rozpoznawane są następujące identyfikatory kolumn (różnią się od identyfikatorów rozpoznawanych przez parametr select).

report_idstring

ID raportu, którego należy użyć. Jeśli zostanie podane, pozostałe parametry są pobierane z raportu (marka, konkurenci, rynek, kraj, filtry). Jeśli podano kraj lub filtry, zastępują one wartości z raportu. Znajdziesz je w adresie URL raportu Brand Radar w Ahrefs: https://app.ahrefs.com/brand-radar/reports/#report_id#/...

brandsarray<object>

Lista nazw marek i stron internetowych do wyszukania.

Default:[]
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
competitorsarray<object>

Lista nazw konkurentów i stron internetowych do wyszukania.

Default:[]
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
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.

data_sourcearray<string>Required

Lista modeli chatbotów. Wszystkie modele można łączyć ze sobą. Moduł claude obsługuje wyłącznie niestandardowe prompty.
Modele google_ai_overviews_keywords i google_ai_mode_keywords raportują widoczność w AI Overviews / AI Mode określoną na podstawie zapytań w wyszukiwarce Google (słów kluczowych), a nie promptów.

Dozwolone wartości:chatgptgoogle_ai_overviewsgoogle_ai_modegeminiperplexitycopilotclaudegrokgoogle_ai_overviews_keywordsgoogle_ai_mode_keywords
countryarray<string>

Lista dwuliterowych kodów krajów (ISO 3166-1 alpha-2).

Dozwolone wartości:adaeafagaialamaoarasatauawazba…
Default:[]
promptsstring

Typ promptów do użycia. Jeśli nie określono, użyte zostaną oba. Niestandardowe prompty wymagają podania report_id.

Dozwolone wartości:ahrefscustom
limitinteger

Liczba wyników do zwrócenia.

Default:1000
datestring (date)

Data, dla której ma zostać wykonane wyszukiwanie, w formacie YYYY-MM-DD.

date_fromstring (date)

Data początkowa okresu historycznego w formacie YYYY-MM-DD.

date_tostring (date)

Data końcowa okresu historycznego w formacie YYYY-MM-DD.

tags_filterobject

Wyrażenie filtra tagów promptu. Wymaga report_id. Wykorzystuje składnię filtrów z następującymi ograniczeniami: jedyną dozwoloną nazwą pola jest "tag"; jedyne dozwolone operatory to: "eq", "neq", "substring", "isubstring", "phrase_match", "iphrase_match", "prefix", "suffix", "empty"; maksymalna głębokość zagnieżdżenia operatorów and i or wynosi 2.

Example:{"or":[{"field":"tag","is":["eq","branded"]},{"field":"tag","is":["eq","competitor"]}]}
brand_filterobject

Wyrażenie filtra widoczności Twojej marki, odpowiadające filtrowi „Twoja marka”. brand_name określa, czy odpowiedź wspomina Twoją markę: "mentioned" lub "not_mentioned". page_status określa, w jaki sposób AI wykorzystała Twoje strony: "cited" (AI pobrała strony z Twojej witryny i odwołała się do nich w odpowiedzi), "found_but_not_cited" (AI pobrała strony z Twojej witryny jako potencjalne źródła, ale nie odwołała się do nich w końcowej odpowiedzi) lub "not_found" (AI nie pobrała żadnych stron z Twojej witryny).
Wykorzystuje składnię filtrów z następującymi ograniczeniami: jedynym dozwolonym operatorem jest "eq"; każde pole stanowi jedną sekcję: podaj jedną wartość albo połącz kilka wartości tego samego pola za pomocą or; sekcje brand_name i page_status połącz na najwyższym poziomie za pomocą and/or. Wybranie wszystkich wartości pola zostanie odrzucone, ponieważ pasuje do wszystkiego (zamiast tego pomiń pole).

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

Zakres wolumenu do filtrowania.

frominteger
tointeger
outputstring

Format wyjściowy.

Dozwolone wartości:jsonphp

Odpowiedzi

topicsarray<object>
countrystring

Kraj powiązany z tematem. Gdy nie zidentyfikowano tematu nadrzędnego, jest to jedyny wybrany kraj lub all, jeśli wybrano wiele krajów albo wszystkie kraje.

mentionsarray<object>

Liczby odpowiedzi dla śledzonej marki i każdego konkurenta.

entitystring

Śledzona marka lub konkurent.

responsesinteger

Liczba odpowiedzi AI, w których pojawia się wzmianka o podmiocie.

responsesinteger

Liczba odpowiedzi AI powiązanych z tematem.

topicstring or null

Temat nadrzędny. Wartość null, gdy nie zidentyfikowano tematu nadrzędnego.

volumeinteger or null

Szacowany miesięczny wolumen wyszukiwań dla tematu.