Docs
Pesquisar na documentação...⌘K

Palavras-chave

API + MCP
GET/v3/gsc/keywords

As solicitações para este endpoint são gratuitas e não consomem unidades da API.

Parâmetros de consulta

project_idinteger

ID do projeto. Obrigatório quando o portfolio_id não é fornecido.

portfolio_idinteger

ID do Portfolio. Quando fornecido, agrega dados de todos os projetos conectados ao GSC no Portfolio.

date_fromstring (date)Obrigatório

A data de início do período histórico, no formato YYYY-MM-DD.

date_tostring (date)

A data de término do período histórico, no formato YYYY-MM-DD.

search_typestring

O tipo de resultados da pesquisa a serem retornados (web, imagem, vídeo, notícias).

Valores permitidos:webimagevideonews
Padrão:web
countrystring

Um código de país de duas letras (ISO 3166-1 alpha-2).

Valores permitidos:adaeafagaialamaoarasatauawazba…
devicestring

Filtra por tipo de dispositivo (DESKTOP, MOBILE, TABLET). Se não especificado, todos os dispositivos serão incluídos.

Valores permitidos:desktopmobiletablet
limitinteger

O número de resultados a retornar.

Padrão:1000
wherestring

Campos compatíveis:

keyword_list_idinteger

O ID de uma lista de palavras-chave existente para a qual serão exibidas métricas.

keyword_listsstring

Filtro de listas de palavras-chave (string JSON). Oferece suporte a include (is), exclude (is_not), empty (não está em nenhuma lista) e not_empty (está em alguma lista).

outputstring

O formato de saída.

Valores permitidos:jsonphpxml

Respostas

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

Posição média (decimal, ex.: 4,7)

top_urlstring (url) or null
urls_countinteger