Docs
Cerca nella documentazione...⌘K

Risposte AI

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

Le richieste a questo endpoint consumano unità API in base al parametro prompts: le richieste che restituiscono solo i dati dei prompt personalizzati sono gratuite, mentre le richieste che includono i dati dei prompt Ahrefs seguono il prezzo standard delle unità API.

Corpo della richiesta

selectarray<string>Required

Un elenco di 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
limitinteger

Il numero di risultati da restituire.

Default:1000
datestring (date)

La data da cercare nel formato YYYY-MM-DD.

date_comparedstring (date)

Una data con cui confrontare date, nel formato YYYY-MM-DD. Deve essere rigorosamente precedente a date. Se impostata, il report include tutti i prompt a cui è stata data risposta in una delle due date e il campo status riporta come ciascuno è cambiato tra le due. Un prompt a cui è stata data risposta solo in date_compared viene indicato come lost e il resto dei suoi campi descrive la risposta di date_compared, poiché non ne ha una in date.

order_by

Come ordinare i risultati: in base a una colonna oppure in base a come le risposte parlano di un brand, come nella pagina Sentiment di Brand Radar.

Una colonna in base alla quale ordinare i risultati.

Valori consentiti:relevancevolume
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" ] } ] }
brand_filterobject

Un’espressione di filtro per la visibilità del tuo brand, che rispecchia il filtro «Il tuo brand». brand_name verifica se una risposta menziona il tuo brand: "mentioned" o "not_mentioned". page_status verifica in che modo l’IA ha usato le tue pagine: "cited" (l’IA ha recuperato pagine dal tuo sito e le ha citate nella risposta), "found_but_not_cited" (l’IA ha recuperato pagine dal tuo sito come potenziali fonti, ma non le ha citate nella risposta finale) o "not_found" (l’IA non ha recuperato alcuna pagina dal tuo sito).
Usa la sintassi dei filtri con le seguenti restrizioni: l’unico operatore valido è "eq"; ogni campo è una sezione: specifica un singolo valore oppure combina più valori dello stesso campo con or; unisci le sezioni brand_name e page_status con un and/or di primo livello. La selezione di tutti i valori di un campo viene rifiutata, poiché corrisponde a tutto (in tal caso ometti il campo).

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

L’intervallo di volume da usare come filtro.

frominteger
tointeger
changesobject

Richiede date_compared. Mantiene solo i prompt che sono cambiati in uno dei modi selezionati qui. Le tre colonne sono in OR tra loro, così come lo sono i valori all’interno di ciascuna colonna; quindi una colonna omessa o vuota non aggiunge nulla al filtro e un oggetto completamente vuoto mantiene ogni prompt.

promptarray<string>

Mantieni i prompt a cui è stata data risposta solo in una delle due date (new, lost) o in entrambe (no_change).

Valori consentiti:newlostno_change
mentionsarray<string>

Mantieni i prompt in cui l’insieme dei tuoi brand menzionati nella risposta ha acquisito un brand (new), ne ha perso uno (lost) o è identico in entrambe le date (no_change). I competitor non vengono considerati.

Valori consentiti:newlostno_change
citationsarray<string>

Mantieni i prompt in cui l’insieme dei tuoi domini citati dalla risposta ha acquisito un dominio (new), ne ha perso uno (lost) o è identico in entrambe le date (no_change). I competitor non vengono considerati.

Valori consentiti:newlostno_change
sentiment_filterobject

Un filtro su come le risposte parlano dei tuoi brand e dei concorrenti, come il filtro Sentiment in Brand Radar. Usa la sintassi dei filtri con tre campi:

Campi disponibili:
  • brand (obbligatorio): un nome da brands o competitors, con "eq".
  • sentiment (facoltativo): positive, neutral, negative o mixed. Con "eq", il brand viene menzionato con questo sentiment. Con "neq", il brand viene menzionato con un sentiment, ma mai con questo. Con "empty", il brand non viene mai menzionato con un sentiment, includendo anche le risposte che non lo menzionano. Con not "empty", il brand viene menzionato con qualche sentiment. Senza sentiment, corrisponde qualsiasi risposta che menzioni il brand.
  • aspect (facoltativo): a cosa si riferisce il sentiment, con "eq": features_specs, performance_effectiveness, price_value, reputation_popularity, quality_reliability, design_comfort, usability_compatibility, availability_delivery, safety_health, service_support o general.
    Ogni regola riguarda un solo brand: una condizione, oppure un and di condizioni. Per combinare le regole, inseriscine ciascuna nel proprio and e uniscile con un and o or di primo livello.
Example:{ "or": [ { "and": [ { "field": "brand", "is": [ "eq", "Adidas" ] }, { "field": "sentiment", "is": [ "eq", "negative" ] } ] }, { "and": [ { "field": "brand", "is": [ "eq", "Nike" ] }, { "field": "sentiment", "is": [ "eq", "positive" ] }, { "field": "aspect", "is": [ "eq", "price_value" ] } ] } ] }
opinions_firstboolean

Mette le risposte con una menzione positiva, negativa o mista di un brand tracciato prima delle altre, con ciascun gruppo ordinato per pertinenza, come vengono elencate nella pagina Sentiment in Brand Radar. Solo con order_by relevance.

Default:false
outputstring

Il formato di output.

Valori consentiti:jsonphp

Risposte

ai_responsesarray<object>
brand_sentimentarray<object>

Ogni menzione di un brand tracciato nella risposta, prima i tuoi brand e poi i concorrenti nel loro ordine, con il modo in cui la risposta ne parla.

brandstring

Il brand tracciato menzionato.

sentimentstring or null

Il modo in cui la risposta parla del brand in questa menzione. Null quando non è disponibile.

Valori consentiti:positiveneutralnegativemixednull
aspectstring or null

Di cosa tratta la menzione, ad esempio prezzo o qualità. Null quando non è disponibile.

Valori consentiti:features_specsperformance_effectivenessprice_valuereputation_popularityquality_reliabilitydesign_comfortusability_compatibilityavailability_deliverysafety_healthservice_supportgeneralnull
snippetstring or null

La frase che contiene la menzione. Null quando non è possibile trovarla nella risposta.

countrystring

Il paese della domanda.

data_sourcestring

Il modello di chatbot che ha generato la risposta.

funnel_stagestring or null

La fase del funnel del prompt. Null quando non è disponibile alcuna fase del funnel.

Valori consentiti:awarenessconsiderationdecisionunclearnull
intentarray<string>

Le etichette di intento del prompt, tra cui l’intento principale, i sottotipi e gli attributi brandizzati/locali. Un array vuoto indica che non sono disponibili etichette di intento.

Valori consentiti:informationalnavigationaltransactionalbrandedcommercialcomparisonhow_tolocalopinionrecommendation
last_updatedstring (date)

La data dell’ultimo aggiornamento dei dati.

linksarray<object>

(10 unità) I link utilizzati per la risposta.

urlstring
titlestring or null
questionstring

La domanda posta dall'utente.

responsestring

(10 unità) La risposta del modello.

search_queriesarray<string>

La query di ricerca utilizzata dal chatbot per trovare informazioni per la risposta. Nota: se data_source non include chatgpt o perplexity, questo campo sarà sempre vuoto.

statusstring or null

Come il prompt è cambiato tra date_compared e date. Null, a meno che non sia impostato date_compared. new — risposta presente in date ma non in date_compared. lost — risposta presente in date_compared ma non in date; il resto di questa riga descrive la risposta di date_compared, poiché in date non ce n’è alcuna. no_change — risposta presente in entrambe le date, il che non dice nulla sul fatto che la risposta in sé, le sue menzioni o le sue citazioni siano cambiate.

Valori consentiti:newlostno_changenull
tagsarray<string>

Tag assegnati alla query.

volumeinteger

(10 unità) Ricerche mensili stimate. Il dato si basa sulle nostre stime per Google, sommando il volume di ricerca delle parole chiave correlate in cui questa domanda compare nella sezione "People Also Ask".