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

Páginas

API + MCP
GET/v3/gsc/pages

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:

outputstring

O formato de saída.

Valores permitidos:jsoncsvxmlphp

Respostas

pagesarray<object>
clicksinteger or null
ctrnumber (float) or null
impressionsinteger or null
keywords_countinteger
pagestring (url)
positionnumber (float) or null

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

top_keywordstring or null
traffic_valuenumber (float) or null

Valor estimado do tráfego em USD