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

Desempenho por posição

API + MCP
GET/v3/gsc/performance-by-position

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
wherestring

Campos compatíveis:

Campos disponíveis:
  • url

O filtro é uma string JSON que representa uma expressão booleana e deve seguir a estrutura abaixo:

<bool_filter> ::= { "and" : <bool_filter>+ }
              |   { "or" : <bool_filter>+ }
              |   { "not" : <bool_filter> }
              |   <expr>

<expr> ::= {
             "field" : <dimension|metric>,
             ? "is": <condition>,
           }

<condition> ::= [ "eq", <value> ]
            |   [ "neq", <value> ]
            |   [ "gt", <value> ]
            |   [ "gte", <value> ]
            |   [ "lt", <value> ]
            |   [ "lte", <value> ]
            |   [ "substring", <value> ]
            |   [ "isubstring", <value> ]
            |   [ "phrase_match", <value> ]
            |   [ "iphrase_match", <value> ]
            |   [ "prefix", <value> ]
            |   [ "suffix", <value> ]
outputstring

O formato de saída.

Valores permitidos:jsoncsvxmlphp

Respostas

metricsarray<object>
clicksinteger
clicks_percentnumber (float)
impressionsinteger
impressions_percentnumber (float)
keyword_countinteger
keyword_count_percentnumber (float)
position_rangestring