Search Console

Dados de desempenho do Google Search Console (impressões, cliques, CTR, posição média) para projetos com uma propriedade do GSC ligada. Requer o plano Growth ou superior. ctr é uma fração entre 0 e 1 e position é a média ponderada pelas impressões. O cabeçalho de resposta X-Search-Console-Backend identifica se as leituras são stored ou live. As leituras de dados sincronizados usam dados já sincronizados sem contactar o Google. As leituras em direto devolvem ERR_SEARCH_CONSOLE_ACCESS_REVOKED (403) quando o acesso ao Google foi revogado; volte a ligar a propriedade em Preferências > Definições do projeto > Ligações. Devolvem ERR_SEARCH_CONSOLE_UPSTREAM (503) quando o Google está indisponível ou a quota foi excedida; aguarde o número de segundos indicado em Retry-After antes de tentar novamente. As leituras de dados sincronizados recusam consultas, páginas e pedidos restringidos com ERR_INVALID_PARAM. Para consultas e páginas, total conta as linhas de um único pedido ao Google, até 25 000 (truncated: true quando esse limite é atingido). A soma das linhas das listas não corresponde aos totais: para obter o total de um conjunto de páginas ou consultas, chame /search_console/summary com filters e sem dimension. Um projeto pode ligar até 10 propriedades: property lê uma delas (a principal, se for omitido), ou combina várias com uma lista separada por vírgulas ou com all.

GET/search_console/properties

As propriedades ligadas ao projeto, a principal em primeiro lugar, com o respetivo tipo (domain ou url_prefix) e estado. Cada id é um valor que o parâmetro property dos restantes endpoints do Search Console aceita.

Parâmetros:
  • project_idobrigatório
  • outputflat|csv

GET/search_console/summary

Totais gerais do intervalo, de toda a propriedade salvo se filters os restringir, com uma desagregação opcional agregada no mesmo intervalo. breakdown_truncated: true significa que a desagregação omitiu linhas. As linhas da dimensão query excluem as consultas anonimizadas, e as das dimensões page e searchAppearance são contabilizadas por página e não por propriedade, pelo que as linhas da desagregação podem diferir dos totais.

Parâmetros:
  • project_idobrigatório
  • propertyum id, uma lista separada por vírgulas ou all
  • range
  • from
  • to
  • dimensioncountry|device|page|query|searchAppearance|property
  • limitpredefinido e máximo 1000
  • search_typeweb|image|video|news|discover|googleNews
  • filters
  • data_statefinal|all
  • aggregation_typeauto|byPage|byProperty

GET/search_console/timeseries

Séries agrupadas por dia, semana ou mês, de toda a propriedade salvo se filters as restringir.

Parâmetros:
  • project_idobrigatório
  • propertyum id, uma lista separada por vírgulas ou all
  • range
  • from
  • to
  • granularityday|week|month
  • search_typeweb|image|video|news|discover|googleNews
  • filters
  • data_statefinal|all
  • aggregation_typeauto|byPage|byProperty
  • outputflat|csv

GET/search_console/queries

Principais consultas de pesquisa do intervalo, ordenadas e paginadas. Subestima intencionalmente as consultas anonimizadas, pelo que não somam exatamente os totais do resumo (tal como na interface do GSC).

Parâmetros:
  • project_idobrigatório
  • propertyum id, uma lista separada por vírgulas ou all
  • range
  • from
  • to
  • sortimpressions|clicks|ctr|position
  • page
  • per_page
  • start_row
  • search_typeweb|image|video|news|discover|googleNews
  • filters
  • data_statefinal|all
  • aggregation_typeauto|byPage|byProperty
  • outputflat|csv

GET/search_console/pages

Principais páginas de destino do intervalo, ordenadas e paginadas. O mesmo formato do endpoint de consultas, em que a chave de cada linha é um URL de página.

Parâmetros:
  • project_idobrigatório
  • propertyum id, uma lista separada por vírgulas ou all
  • range
  • from
  • to
  • sortimpressions|clicks|ctr|position
  • page
  • per_page
  • start_row
  • search_typeweb|image|video|news|discover|googleNews
  • filters
  • data_statefinal|all
  • aggregation_typeauto|byPage|byProperty
  • outputflat|csv

GET/search_console/rows

Linhas agrupadas por até três dimensões, por exemplo página e consulta, ou data e página, ordenadas e paginadas. Cada dimensão ocupa um campo próprio. O Google devolve, no máximo, 25 000 linhas por pedido: truncated: true indica que esse limite foi atingido e start_row lê o bloco seguinte.

Parâmetros:
  • project_idobrigatório
  • dimensionsobrigatório, lista separada por vírgulas com 1 a 3 valores entre date|country|device|page|query|searchAppearance|property
  • propertyum id, uma lista separada por vírgulas ou all
  • range
  • from
  • to
  • sortimpressions|clicks|ctr|position
  • page
  • per_page
  • start_row
  • search_type
  • filters
  • data_statefinal|all
  • aggregation_typeauto|byPage|byProperty
  • outputflat|csv

GET/search_console/opportunities

Consultas situadas logo abaixo das três primeiras posições e com impressões suficientes, ordenadas pelos cliques adicionais que obteriam se subissem para uma dessas posições, calculados com o CTR que as consultas da própria propriedade já presentes nas três primeiras posições registam no mesmo período. Utilize-o para encontrar as consultas em que uma pequena melhoria de posicionamento traria mais tráfego.

Parâmetros:
  • project_idobrigatório
  • propertyum id, uma lista separada por vírgulas ou all
  • range
  • from
  • to
  • min_impressionspredefinição 100
  • min_positionpredefinição 4
  • max_positionpredefinição 20
  • page
  • per_page
  • search_type
  • filters
  • data_statefinal|all
  • aggregation_typeauto|byPage|byProperty
  • outputflat|csv

GET/search_console/cannibalization

Consultas em que duas ou mais páginas obtêm, cada uma, pelo menos a proporção min_share das impressões, com as páginas que competem por cada consulta. O Google contabiliza estas impressões por página, pelo que o valor de uma consulta pode ser aqui superior ao de toda a propriedade. Utilize-o para encontrar as palavras-chave que várias páginas do site disputam entre si e decidir que páginas fundir, redirecionar ou diferenciar.

Parâmetros:
  • project_idobrigatório
  • propertyum id, uma lista separada por vírgulas ou all
  • range
  • from
  • to
  • min_impressionspredefinição 100
  • min_sharede 0.01 a 0.5, predefinição 0.1
  • page
  • per_page
  • search_type
  • filters
  • data_statefinal|all
  • aggregation_typeauto|byPage|byProperty
  • outputflat|csv

GET/search_console/decay

As páginas, ou as consultas, que mais cliques perderam face ao período imediatamente anterior de igual duração, com os cliques, as impressões e a posição em ambos os períodos. O período pedido termina no último dia já publicado pelo Google (compared_through), pelo que os dias cujos dados ainda estão a ser preenchidos nunca aparecem como uma perda. Utilize-o para encontrar as páginas que estão a perder tráfego e para distinguir a perda de posicionamento (uma posição pior) da perda de procura (menos impressões com uma posição estável).

Parâmetros:
  • project_idobrigatório
  • propertyum id, uma lista separada por vírgulas ou all
  • range
  • from
  • to
  • dimensionpage|query
  • min_clickspredefinição 10
  • page
  • per_page
  • search_type
  • filters
  • data_statefinal|all
  • aggregation_typeauto|byPage|byProperty
  • outputflat|csv

GET/search_console/brand_split

Impressões e cliques das consultas que incluem o nome da marca e das que não o incluem, juntamente com os totais. Uma consulta de marca contém, como palavra inteira, um dos termos de marca do projeto: o nome da marca, os nomes correspondentes, os nomes das aplicações e o domínio, cada um também na sua forma sem acentos. O Google aplica esta divisão a todas as consultas que contabiliza. Exclui as consultas anonimizadas de qualquer filtro por consulta, pelo que unclassified reúne o que nenhum dos dois grupos contabiliza. Utilize-o para ver quanto do tráfego de pesquisa provém de pessoas que já conhecem a marca e quanto provém de pesquisas de descoberta, e como cada grupo evolui de um intervalo de datas para outro.

Parâmetros:
  • project_idobrigatório
  • propertyum id, uma lista separada por vírgulas ou all
  • range
  • from
  • to
  • search_type
  • filters
  • data_statefinal|all
  • aggregation_typeauto|byPage|byProperty

GET/search_console/ai_visibility_gaps

As principais consultas da propriedade, cruzadas com os prompts do projeto. Uma consulta corresponde ao prompt com o mesmo texto (match_type prompt) ou, se não houver nenhum, a um prompt cujas respostas de IA fizeram essa mesma pesquisa no período (match_type fan_out). Ambas as correspondências são exatas: o mesmo texto depois de passar ambos para minúsculas, retirar os acentos, reduzir os espaços consecutivos a um só e eliminar a pontuação no início ou no fim. Apenas alguns modelos comunicam as suas pesquisas, sobretudo o ChatGPT. Cada consulta com correspondência inclui as respostas de IA do prompt (responses) e a respetiva Taxa de menções no mesmo período. unmatched_only lista a procura de pesquisa que nenhum prompt cobre ainda. Utilize-o para encontrar as pesquisas com muita procura que a monitorização de IA ainda não abrange, as melhores candidatas a adicionar como prompts, e para verificar se as consultas que trazem tráfego do Google também levam a marca a ser mencionada nas respostas de IA.

Parâmetros:
  • project_idobrigatório
  • propertyum id, uma lista separada por vírgulas ou all
  • range
  • from
  • to
  • min_impressionspredefinição 100
  • unmatched_onlytrue|false
  • page
  • per_page
  • search_type
  • filters
  • data_statefinal|all
  • aggregation_typeauto|byPage|byProperty
  • outputflat|csv