Docs
Szukaj w dokumentacji...⌘K

Odpowiedzi AI

API + MCP
POST/v3/brand-radar/ai-responses

Żą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

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
selectarray<string>Required

Lista pól zwracanych w odpowiedzi.

Example:["field_a","field_b"]
whereobject

Wyrażenie filtrujące. Obsługiwane są następujące identyfikatory kolumn (różnią się one od identyfikatorów obsługiwanych przez parametr select).

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"]}]}
limitinteger

Liczba wyników do zwrócenia.

Default:1000
datestring (date)

Data do wyszukania w formacie YYYY-MM-DD.

search_volume_typestring

Raporty widoczności w AI przechodzą na wolumen skorygowany pod kątem AI. Lepiej szacuje on popyt na odpowiedzi AI w chatbotach i wyszukiwarkach AI. Jest obliczany przez skorygowanie wolumenu wyszukiwań Google o szacowane wykorzystanie każdej platformy AI w porównaniu z Google. Ten parametr zostanie wycofany 31 sierpnia 2026 r.; wszystkie żądania będą korzystać z nowego wolumenu skorygowanego pod kątem AI.

Dozwolone wartości:ask_volumekeyword_volume
Default:ask_volume
countryarray<string>

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

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

Kolumna, według której mają zostać posortowane wyniki.

Dozwolone wartości:relevancevolume
Default:relevance
report_idstring

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

promptsstring

Typ promptów, których należy użyć. Jeśli nie zostanie podany, użyte zostaną oba typy. Niestandardowe prompty wymagają podania report_id.

Dozwolone wartości:ahrefscustom
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
marketarray<string>

Lista rynków niszowych Twoich marek. Wycofane od 2026-05-18; krótko po tej dacie ten parametr przestanie działać.

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

Format wyjściowy.

Dozwolone wartości:jsonphp

Odpowiedzi

ai_responsesarray<object>
countrystring

Kraj, którego dotyczy pytanie.

data_sourcestring

Model chatbota, który wygenerował odpowiedź.

last_updatedstring (date)

Data ostatniej aktualizacji danych.

linksarray<object>

(10 jednostek) Linki użyte w odpowiedzi.

urlstring
titlestring or null
questionstring

Pytanie zadane przez użytkownika.

responsestring

(10 jednostek) Odpowiedź z modelu.

search_queriesarray<string>

Zapytanie wyszukiwawcze użyte przez chatbota do znalezienia informacji potrzebnych do odpowiedzi. Uwaga: jeśli data_source nie zawiera chatgpt ani perplexity, to pole zawsze będzie puste.

tagsarray<string>

Tagi przypisane do zapytania.

volumeinteger

(10 jednostek) Szacowana liczba wyszukiwań miesięcznie. Wartość oparta na naszych estymacjach dla Google, wyliczona poprzez połączenie wolumenów wyszukiwań powiązanych słów kluczowych, w których to pytanie pojawia się w sekcji People Also Ask.