Docs
Szukaj w dokumentacji...⌘K

Historia przeglądu – cytowania

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

Żą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 obejmujące dane promptu Ahrefs są rozliczane zgodnie ze standardową wyceną jednostek API.

Każdy podmiot podany w brands (oraz w competitors, jeśli dotyczy) musi zawierać co najmniej jedną wartość w url_groups. Podmioty składające się wyłącznie z names nie są tutaj obsługiwane, ponieważ cytowania są dopasowywane do grup adresów URL.

Treść żądania

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"]}]}
date_tostring (date)

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

date_fromstring (date)Required

Data początkowa okresu historycznego 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:[]
report_idstring

Identyfikator raportu, którego należy użyć. Jeśli zostanie podany, pozostałe parametry zostaną pobrane z raportu (market, country, filters). Jeśli podano country lub filters, zastępują one wartości 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ć.

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:jsoncsvxmlphp

Odpowiedzi

metricsarray<object>
citationsinteger

Szacowana liczba cytowań w odpowiedziach, w których wspomniano adresy URL marki.

datestring (date)