Docs
Szukaj w dokumentacji...⌘K

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 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 podany, pozostałe parametry zostaną pobrane z raportu (kraj, filtry). Jeśli podasz kraj lub filtry, zastąpią one wartości z raportu. Znajdziesz go 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
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
date_fromstring (date)Required

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