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

Visão geral dos concorrentes

API + MCP
GET/v3/rank-tracker/competitors-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

Uma data para gerar relatório das métricas, no formato YYYY-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:jsonphp

Respostas

keywordsarray<object>
competitors_listarray<object>

Informações de concorrentes para uma determinada palavra-chave. Os seguintes campos estão incluídos: url, url_prev, position, position_prev, best_position_kind, best_position_kind_prev, traffic, traffic_prev, value, value_prev. Campos que terminam em prev são incluídos apenas na visualização comparada.

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
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.

languagestring

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

locationstring

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

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_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.

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".