Docs
Cerca nella documentazione...⌘K

Parole chiave

API + MCP
GET/v3/gsc/keywords

Le richieste a questo endpoint sono gratuite e non consumano alcuna unità API.

Parametri della query

project_idinteger

ID del progetto. Obbligatorio se non viene fornito portfolio_id.

portfolio_idinteger

ID del portfolio. Se fornito, aggrega i dati di tutti i progetti collegati a GSC nel portfolio.

date_fromstring (date)Obbligatorio

La data di inizio del periodo storico, in formato YYYY-MM-DD.

date_tostring (date)

La data di fine del periodo storico, in formato YYYY-MM-DD.

search_typestring

Il tipo di risultati di ricerca da restituire (web, image, video, news).

Valori consentiti:webimagevideonews
Predefinita:web
countrystring

Un codice paese a due lettere (ISO 3166-1 alpha-2).

Valori consentiti:adaeafagaialamaoarasatauawazba…
devicestring

Filtra per tipo di dispositivo (DESKTOP, MOBILE, TABLET). Se non specificato, vengono inclusi tutti i dispositivi.

Valori consentiti:desktopmobiletablet
limitinteger

Il numero di risultati da restituire.

Predefinita:1000
wherestring

Campi supportati:

keyword_list_idinteger

L’ID di un elenco di parole chiave esistente per il quale mostrare le metriche.

keyword_listsstring

Filtro per gli elenchi di parole chiave (stringa JSON). Supporta include (is), exclude (is_not), empty (non presente in alcun elenco) e not_empty (presente in almeno un elenco).

outputstring

Il formato di output.

Valori consentiti:jsonphpxml

Risposte

keywordsarray<object>
clicksinteger or null
ctrnumber (float) or null
impressionsinteger or null
keywordstring
keyword_list_labelsarray<string>
positionnumber (float) or null

Posizione media (decimale, ad es. 4.7)

top_urlstring (url) or null
urls_countinteger