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

Visão geral

API + MCP
GET/v3/rank-tracker/overview

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

Parâmetros de consulta

timeoutinteger

Um tempo limite manual em segundos.

limitinteger

O número de resultados a retornar.

Padrão:1000
order_bystring

Uma lista de colunas separadas por vírgula para ordenar os resultados, com direção opcional. Consulte o schema de resposta para ver identificadores de coluna válidos.

Example:field_a,field_b:asc,field_c:desc
wherestring

A expressão do filtro. Os seguintes identificadores de coluna são reconhecidos (isso difere dos identificadores reconhecidos pelo parâmetro select).

selectstringObrigatório

Uma lista de colunas separadas por vírgulas a serem retornadas. Consulte o Schema de resposta para ver identificadores de coluna válidos.

date_comparedstring (date)

Uma data para comparar as métricas, no formato YYYY-MM-DD.

datestring (date)Obrigatório

A data de referência das métricas, no formato AAAA-MM-DD.

devicestringObrigatório

Escolha entre rankings para dispositivos móveis e desktop.

Valores permitidos:desktopmobile
project_idintegerObrigatório

O identificador exclusivo do projeto. Você pode encontrá-lo na URL do seu projeto do Rank Tracker no Ahrefs: https://app.ahrefs.com/rank-tracker/overview/#project_id#

volume_modestring

O modo de cálculo do volume de pesquisa: mensal ou média. Ele afeta o volume, o tráfego e o valor do tráfego.

Valores permitidos:monthlyaverage
Padrão:monthly
outputstring

O formato de saída.

Valores permitidos:jsoncsvxmlphp

Respostas

overviewsarray<object>
best_position_has_thumbnailboolean or null

A posição mais alta (ou a URL de destino, se definida) tem uma miniatura.

best_position_has_thumbnail_previousboolean or null

A posição mais alta (ou a URL de destino, se definida) tinha uma miniatura na data de comparação.

best_position_has_video_previewboolean or null

A posição mais alta (ou a URL de destino, se definida) tem uma prévia de vídeo.

best_position_has_video_preview_previousboolean or null

A posição mais alta (ou a URL de destino, se definida) tinha uma prévia de vídeo na data de comparação.

best_position_kindstring or null

O tipo da posição mais alta (ou da URL de destino, se definida): orgânica, paga ou um dos Recursos da SERP.

Allowed values:paid_toppaid_bottompaid_rightpaid_sitelinkorganicsitelinksnippetimagearticleknowledge_cardknowledge_panellocal_packlocal_teasernewsquestionreviewshoppingtweetspellingvideodiscussionai_overviewai_overview_sitelinkorganic_shopping
best_position_kind_previousstring or null

O tipo de melhor posição (ou das URLs de destino, se definidas) na data de comparação.

Allowed values:paid_toppaid_bottompaid_rightpaid_sitelinkorganicsitelinksnippetimagearticleknowledge_cardknowledge_panellocal_packlocal_teasernewsquestionreviewshoppingtweetspellingvideodiscussionai_overviewai_overview_sitelinkorganic_shopping
clicksinteger or null

A métrica de cliques se refere à média mensal do número de cliques nos resultados de pesquisa que as pessoas fazem enquanto pesquisam pela sua palavra-chave alvo. Algumas pesquisas geram cliques em múltiplos resultados enquanto outras podem não gerar nenhum clique.

clicks_per_searchnumber (float) or null

Cliques por Pesquisa são a Proporção de Cliques para o Volume de Pesquisa de Palavras-Chave. Exibem quantos resultados de pesquisa diferentes são clicados, em média, quando as pessoas procuram pela palavra-chave alvo em um determinado país.

cost_per_clickinteger or null

O Custo por Clique mostra o preço médio que os anunciantes pagam por cada clique em um anúncio para uma palavra-chave nos resultados de pesquisa paga.

countrystring

O país em que uma determinada palavra-chave está sendo rastreada. Um código de país de duas letras (ISO 3166-1 alpha-2).

Allowed values:ADAEAFAGAIALAMAOAQARASATAUAWAXAZBABBBDBEBFBGBHBIBJBLBMBNBOBQBRBSBTBVBWBYBZCACCCDCFCGCHCICKCLCMCNCOCRCUCVCWCXCYCZDEDJDKDMDODZECEEEGEHERESETFIFJFKFMFOFRGAGBGDGEGFGGGHGIGLGMGNGPGQGRGSGTGUGWGYHKHMHNHRHTHUIDIEILIMINIOIQIRISITJEJMJOJPKEKGKHKIKMKNKPKRKWKYKZLALBLCLILKLRLSLTLULVLYMAMCMDMEMFMGMHMKMLMMMNMOMPMQMRMSMTMUMVMWMXMYMZNANCNENFNGNINLNONPNRNUNZOMOTHERPAPEPFPGPHPKPLPMPNPRPSPTPWPYQARERORSRURWSASBSCSDSESGSHSISJSKSLSMSNSOSRSSSTSVSXSYSZTCTDTFTGTHTJTKTLTMTNTOTRTTTVTWTZUAUGUMUSUYUZVAVCVEVGVIVNVUWFWSYEYTZAZMZW
country_prevstring

O país em que uma determinada palavra-chave está sendo rastreada na data de comparação. Um código de país de duas letras (ISO 3166-1 alpha-2).

Allowed values:ADAEAFAGAIALAMAOAQARASATAUAWAXAZBABBBDBEBFBGBHBIBJBLBMBNBOBQBRBSBTBVBWBYBZCACCCDCFCGCHCICKCLCMCNCOCRCUCVCWCXCYCZDEDJDKDMDODZECEEEGEHERESETFIFJFKFMFOFRGAGBGDGEGFGGGHGIGLGMGNGPGQGRGSGTGUGWGYHKHMHNHRHTHUIDIEILIMINIOIQIRISITJEJMJOJPKEKGKHKIKMKNKPKRKWKYKZLALBLCLILKLRLSLTLULVLYMAMCMDMEMFMGMHMKMLMMMNMOMPMQMRMSMTMUMVMWMXMYMZNANCNENFNGNINLNONPNRNUNZOMOTHERPAPEPFPGPHPKPLPMPNPRPSPTPWPYQARERORSRURWSASBSCSDSESGSHSISJSKSLSMSNSOSRSSSTSVSXSYSZTCTDTFTGTHTJTKTLTMTNTOTRTTTVTWTZUAUGUMUSUYUZVAVCVEVGVIVNVUWFWSYEYTZAZMZW
created_atstring (date-time)

A data em que uma palavra-chave foi adicionada ao projeto.

is_brandedboolean

Intenção do usuário: marca. O usuário está buscando um nome de marca ou empresa específica.

is_commercialboolean

Intenção do usuário: comercial. O usuário está comparando produtos ou serviços antes de tomar uma decisão de compra.

is_informationalboolean

Intenção do usuário: informacional. O usuário está buscando informações ou uma resposta para uma pergunta específica.

is_localboolean

Intenção do usuário: local. O usuário está buscando informações relevantes para um local específico ou serviços próximos.

is_navigationalboolean

Intenção do usuário: navegacional. O usuário está buscando um site ou página da web específica.

is_transactionalboolean

Intenção do usuário: transacional. O usuário está pronto para concluir uma ação, geralmente uma compra.

keywordstring

A palavra-chave para a qual seu alvo se classifica.

keyword_difficultyinteger or null

Uma estimativa de quão difícil é ranquear entre os 10 melhores resultados de busca orgânica para uma palavra-chave, em uma escala de 100 pontos.

keyword_has_databoolean

Retornará false se a palavra-chave ainda estiver sendo processada e nenhuma SERP tiver sido coletada ainda.

keyword_is_frozenboolean

Indica se uma palavra-chave excedeu o limite de palavras-chave rastreadas do seu plano. Essas palavras-chave ficam "congeladas", ou seja, não têm suas posições atualizadas.

keyword_prevstring

A palavra-chave para a qual seu alvo se classifica na data de comparação.

languagestring

O idioma da SERP para o qual uma determinada palavra-chave está sendo rastreada.

language_prevstring

O idioma da SERP na data de comparação.

locationstring

O local (país, estado/província ou cidade) em que uma determinada palavra-chave está sendo rastreada.

location_prevstring

O local (país, estado/província ou cidade) em que uma determinada palavra-chave está sendo rastreada na data de comparação.

parent_topicstring or null

O Tópico Principal determina se você consegue ranquear para sua palavra-chave alvo enquanto, visa um tópico mais geral. Para identificar o Tópico Principal, usamos a página ranqueada em primeiro lugar para sua palavra-chave e encontramos a palavra-chave responsável por enviar mais tráfego para essa página.

positioninteger or null

A melhor posição (ou das URLs de destino, se definidas) na busca orgânica.

position_diffinteger or null

A mudança na melhor posição (ou das URLs de destino, se definidas) entre as datas selecionadas.

position_previnteger or null

A melhor posição (ou das URLs de destino, se definidas) na data de comparação.

search_type_imagenumber (float) or null

A pesquisa do tipo Imagem mostra a porcentagem de pesquisas por uma palavra-chave realizadas para imagens, destacando o interesse por conteúdo visual.

search_type_newsnumber (float) or null

A pesquisa do tipo Notícias mostra a porcentagem de pesquisas para uma palavra-chave feitas para artigos de notícias.

search_type_videonumber (float) or null

A pesquisa do tipo Vídeo mostra a porcentagem de buscas por uma palavra-chave realizadas para vídeos, refletindo o interesse em conteúdo em vídeo.

search_type_webnumber (float) or null

A pesquisa do tipo Web mostra a porcentagem de buscas por uma palavra-chave feita para conteúdo geral da web, indicando interesse em uma ampla gama de informações.

serp_featuresarray<string>

Os recursos de SERP que aparecem nos resultados de pesquisa para uma palavra-chave.

Allowed values:paid_toppaid_bottompaid_rightpaid_sitelinkorganicsitelinksnippetimagearticleknowledge_cardknowledge_panellocal_packlocal_teasernewsquestionreviewshoppingtweetspellingvideodiscussionai_overviewai_overview_sitelinkorganic_shoppingimage_thvideo_thai_overview_found
serp_features_prevarray<string>

Os Recursos da SERP que aparecem nos resultados de pesquisa para uma palavra-chave na data de comparação.

Allowed values:paid_toppaid_bottompaid_rightpaid_sitelinkorganicsitelinksnippetimagearticleknowledge_cardknowledge_panellocal_packlocal_teasernewsquestionreviewshoppingtweetspellingvideodiscussionai_overviewai_overview_sitelinkorganic_shoppingimage_thvideo_thai_overview_found
serp_updatedstring (date-time) or null

A data da última análise dos resultados de pesquisa para uma palavra-chave.

serp_updated_prevstring (date-time) or null

A data em que verificamos os resultados do mecanismo de pesquisa até a data de comparação.

tagsarray<string>

Uma lista de tags atribuídas a uma determinada palavra-chave.

tags_prevarray<string>

Uma lista de tags atribuídas a uma determinada palavra-chave na data de comparação.

target_positions_countinteger

O número de URLs-alvo classificadas para uma palavra-chave.

trafficinteger or null

Uma estimativa do número de visitas mensais que uma página recebe da pesquisa orgânica no último mês ou ao longo dos últimos 12 meses de dados conhecidos, dependendo do parâmetro "volume_mode".

traffic_diffinteger or null

A alteração no tráfego entre as datas selecionadas.

traffic_previnteger or null

Uma estimativa do número de visitas mensais que uma página recebe da pesquisa orgânica no último mês ou ao longo dos últimos 12 meses de dados conhecidos, dependendo do parâmetro "volume_mode".

urlstring (url) or null

A URL mais bem classificada (ou URL-alvo, se definida) na pesquisa orgânica.

url_prevstring (url) or null

A URL mais bem classificada (ou URL-alvo, se definida) na data de comparação.

volumeinteger or null

Uma estimativa do número médio de pesquisas mensais de uma palavra-chave no último mês ou ao longo dos últimos 12 meses de dados conhecidos, dependendo do parâmetro "volume_mode".

volume_desktop_pctnumber (float) or null

A porcentagem do volume de pesquisa total que vem de dispositivos desktop.

volume_mobile_pctnumber (float) or null

A porcentagem do volume de pesquisa total que vem de dispositivos móveis.