Docs
Cerca nella documentazione...⌘K

Citazioni

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

Le richieste a questo endpoint consumano unità API in base al parametro prompts: le richieste che restituiscono solo dati di prompt personalizzati sono gratuite, mentre quelle che includono dati di prompt di Ahrefs seguono la tariffazione Standard per le unità API.

Ogni entità fornita in brands (e in competitors, quando applicabile) deve includere almeno un valore in url_groups. Le entità costituite solo da names non sono supportate qui, perché le citazioni vengono abbinate ai gruppi di URL.

Corpo della richiesta

selectarray<string>Required

Un elenco dei campi da restituire.

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

L’espressione di filtro. Sono riconosciuti i seguenti identificatori di colonna (questi differiscono dagli identificatori riconosciuti dal parametro select).

report_idstring

L’ID del report da usare. Se ne viene fornito uno, gli altri parametri vengono presi dal report (brand, concorrenti, mercato, paese, filtri). Se vengono forniti paese o filtri, questi sovrascrivono quelli del report. Puoi trovarlo nell’URL del report Brand Radar in Ahrefs: https://app.ahrefs.com/brand-radar/reports/#report_id#/...

brandsarray<object>

Un elenco di nomi e siti web dei brand da cercare.

Default:[]
At least one of names or url_groups is required
namesarray<string>

I nomi del brand/concorrente

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

Il dominio del target

Example:ahrefs.com
scopestringrequired

Ambito del target.

Valori consentiti:urlpathdomainsubdomains
competitorsarray<object>

Un elenco di nomi e siti web dei concorrenti da cercare.

Default:[]
At least one of names or url_groups is required
namesarray<string>

I nomi del brand/concorrente

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

Il dominio del target

Example:ahrefs.com
scopestringrequired

Ambito del target.

Valori consentiti:urlpathdomainsubdomains
content_filterobject

Frasi facoltative usate per includere o escludere i risultati in base al loro contenuto.

includearray<string>

Mostra solo i risultati che contengono almeno una di queste frasi esatte.

excludearray<string>

Nascondi i risultati che contengono una qualsiasi di queste frasi esatte.

data_sourcearray<string>Required

Un elenco di modelli di chatbot. Tutti i modelli possono essere combinati tra loro. Il modulo claude supporta solo prompt personalizzati.
I modelli google_ai_overviews_keywords e google_ai_mode_keywords riportano la visibilità in AI Overviews / AI Mode calcolata a partire dalle query di ricerca su Google (parole chiave), anziché dai prompt.

Valori consentiti:chatgptgoogle_ai_overviewsgoogle_ai_modegeminiperplexitycopilotclaudegrokgoogle_ai_overviews_keywordsgoogle_ai_mode_keywords
countryarray<string>

Un elenco di codici paese a due lettere (ISO 3166-1 alpha-2).

Valori consentiti:adaeafagaialamaoarasatauawazba…
Default:[]
promptsstring

Il tipo di prompt da utilizzare. Se non specificato, verranno utilizzati entrambi. I prompt personalizzati richiedono la specifica di un report_id.

Valori consentiti:ahrefscustom
tags_filterobject

Un’espressione di filtro per i tag dei prompt. Richiede report_id. Usa la sintassi dei filtri con le seguenti restrizioni: l’unico nome di campo valido è "tag"; gli unici operatori validi sono: "eq", "neq", "substring", "isubstring", "phrase_match", "iphrase_match", "prefix", "suffix", "empty"; la profondità massima di annidamento di and, or è 2.

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

Il formato di output.

Valori consentiti:jsoncsvxmlphp

Risposte

metricsarray<object>
brandstring

Nome del brand (il tuo brand o un concorrente fornito nella richiesta).

entity_typestring

Indica se la riga rappresenta un aggregato, il tuo brand target o un concorrente.

Valori consentiti:aggregatetargetcompetitor
no_tracked_brandsinteger

Citazioni stimate dalle risposte relative al mercato specificato che non menzionano nessuno degli URL dei brand forniti (il valore è zero quando market non è specificato).

only_competitors_brandsinteger

Citazioni stimate dalle risposte che menzionano solo gli URL dei brand concorrenti.

only_target_brandinteger

Citazioni stimate dalle risposte che menzionano solo gli URL del tuo brand.

target_and_competitors_brandsinteger

Citazioni stimate dalle risposte che menzionano sia gli URL del tuo brand sia quelli dei brand concorrenti.

totalinteger

Totale delle citazioni stimate per gli URL del tuo brand (include sia only_target_brand sia target_and_competitors_brands).