v0.2.0-beta

OpenAPI 3.1.0

Visão geral histórica de ranking

Felo API Support

MIT

Servidor

https://openapi.felo.ai

Bibliotecas Cliente

Shell Curl

DataForSEO

SEO, search-engine results, keyword research, backlinks and AI visibility data.

DataForSEO Operações

post/v1/beta/dataforseo/dataforseo_labs/google/historical_rank_overview/live

Visão geral histórica de ranking

A visão geral de ranking de um domínio como estava em cada ponto do histórico disponível. Este endpoint não aceita parâmetro de limite, mas é cobrado por chamada e não por item, então envie a lista inteira de uma vez. Encapsulado no envelope do DataForSEO: dados em tasks[0].result, resultado em tasks[0].status_code — uma requisição rejeitada ainda retorna HTTP 200. Verifique get_dataforseo_labs_google_available_history primeiro — ele indica as datas existentes, e pedir uma data fora delas não retorna nada, em vez de um erro. O snapshot atual é post_dataforseo_labs_google_domain_rank_overview_live.

Referência de preços

Medição: Custo da resposta reportado.
Estimativa de referência por requisição: USD 0.1356.
Multiplicador de referência do cliente: 1.0. Não o aplique novamente a um valor de cliente já liquidado.

Apenas metadados de referência, não uma cotação da conta, um preço garantido ou um limite de gastos. Créditos de recursos não são créditos Felo. As cobranças finais seguem os registros de cobrança da Felo.

Corpo

application/json

Tipo: array (object | null)[]
- correlate
  Tipo: boolean | null
  
  correlaciona dados com conjuntos de dados obtidos anteriormente
  campo opcional
  valor padrão: true
  se você usar este parâmetro, nosso sistema correlacionará os dados obtidos agora com os conjuntos de dados obtidos anteriormente
  este parâmetro tem como objetivo mitigar inconsistências que possam resultar de alterações em nosso banco de dados
  recomendamos sempre definir correlate como true
- date_from
  Tipo: string | null
  
  data inicial do intervalo de tempo
  campo opcional
  se você não especificar este campo, os dados serão fornecidos para os últimos 6 meses
  valor mínimo possível: 2020-10-01
  formato da data: "yyyy-mm-dd"
- date_to
  Tipo: string | null
  
  data final do intervalo de tempo
  campo opcional
  se você não especificar este campo, a data de hoje será usada por padrão
  formato da data: "yyyy-mm-dd"
  exemplo:
  "2021-04-01"
- ignore_synonyms
  Tipo: boolean | null
  
  ignora palavras-chave altamente semelhantes
  campo opcional
  se definido como true, apenas dados baseados em palavras-chave principais serão retornados, e os dados de todas as palavras-chave altamente semelhantes serão excluídos;
  valor padrão: false
- include_clickstream_data
  Tipo: boolean | null
  
  inclui ou exclui dados de métricas baseadas em clickstream no resultado
  campo opcional
  se o parâmetro for definido como true, você receberá os campos clickstream_etv, clickstream_gender_distribution e clickstream_age_distribution com dados de clickstream na resposta;
  valor padrão: false;
  
  Observação: dados históricos de clickstream estão disponíveis a partir de 2024/05 (maio de 2024);
  com este parâmetro ativado, você será cobrado em dobro pelo preço da requisição;
  saiba mais sobre como as métricas baseadas em clickstream são calculadas neste artigo da Central de Ajuda
- language_code
  Tipo: string | null
  
  código do idioma
  campo obrigatório se você não especificar language_name
  Observação: é obrigatório especificar language_name ou language_code
  você pode obter a lista de locais disponíveis com seu language_code fazendo uma requisição separada para a
  https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages
  exemplo:
  en
- language_name
  Tipo: string
  
  nome completo do idioma
  campo obrigatório se você não especificar language_code
  Observação: é obrigatório especificar language_name ou language_code
  você pode obter a lista de locais disponíveis com seu language_name fazendo uma requisição separada para a
  https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages
  exemplo:
  English
- location_code
  Tipo: integer
  
  código do local
  campo obrigatório se você não especificar location_name
  Observação: é obrigatório especificar location_name ou location_code
  você pode obter a lista de locais disponíveis com seu location_code fazendo uma requisição separada para a
  https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages
  exemplo:
  2840
- location_name
  Tipo: string
  
  nome completo do local
  campo obrigatório se você não especificar location_code
  Observação: é obrigatório especificar location_name ou location_code
  você pode obter a lista de locais disponíveis com seu location_name fazendo uma requisição separada para a
  https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages
  exemplo:
  United Kingdom
- tag
  Tipo: string | null
  
  identificador de tarefa definido pelo usuário
  campo opcional
  o limite de caracteres é 255
  você pode usar este parâmetro para identificar a tarefa e associá-la ao resultado
  você encontrará o valor de tag especificado no objeto data da resposta
- target
  Tipo: string
  
  domínio
  campo obrigatório
  o nome do domínio do site de destino
  o domínio deve ser especificado sem https:// e www.

Respostas

200
Tipo: object | null · Response36Afe1097B20_DataforseoLabsGoogleHistoricalRankOverviewLiveResponseInfo
cost
Tipo: number | null Formato: double

custo total das tarefas, USD

status_code
Tipo: integer | null

código de status geral você pode encontrar a lista completa dos códigos de resposta aqui

status_message
Tipo: string | null

mensagem informativa geral você pode encontrar a lista completa das mensagens informativas gerais aqui

tasks
Tipo: array (object | null)[] | null

array de tarefas

Tipo: object | null · Response36Afe1097B20_DataforseoLabsGoogleHistoricalRankOverviewLiveTaskInfo
cost
Tipo: number | null Formato: double

custo total das tarefas, USD

data
Tipo: object | null

contém os mesmos parâmetros que você especificou na requisição POST

propertyName
Tipo: object | null
id
Tipo: string | null

identificador da tarefa identificador exclusivo da tarefa em nosso sistema no formato UUID

path
Tipo: array (string | null)[] | null

caminho da URL

result
Tipo: array (object | null)[] | null

array de resultados

items
Tipo: array (object | null)[] | null

contém dados históricos de ranking e tráfego

metrics
Tipo: object | null

dados de ranking relevantes para o domínio especificado

propertyName
Tipo: object · Response36Afe1097B20_DataforseoLabsMetricsInfo
clickstream_age_distribution
Tipo: object | null

distribuição de métricas baseadas em clickstream por idade
para obter resultados para este campo, o parâmetro include_clickstream_data deve ser definido como true
saiba mais sobre como a métrica é calculada neste artigo da central de ajuda

propertyName
Tipo: integer | null Formato: int64

Signed 64-bit integers (long type).

clickstream_etv
Tipo: number | null Formato: double

volume de tráfego estimado com base em dados de clickstream
calculado como o produto dos valores de click-through-rate e de volume de pesquisa de clickstream de todas as palavras-chave para as quais o domínio ranqueia
para obter resultados para este campo, o parâmetro include_clickstream_data deve ser definido como true
saiba mais sobre como a métrica é calculada neste artigo da central de ajuda

clickstream_gender_distribution
Tipo: object | null

distribuição de métricas estimadas baseadas em clickstream por gênero
para obter resultados para este campo, o parâmetro include_clickstream_data deve ser definido como true
saiba mais sobre como a métrica é calculada neste artigo da central de ajuda

propertyName
Tipo: integer | null Formato: int64

Signed 64-bit integers (long type).

count
Tipo: integer | null Formato: int64

contagem total de SERPs orgânicas que contêm o domínio ou subdomínio

estimated_paid_traffic_cost
Tipo: number | null

custo estimado da conversão de tráfego de pesquisa orgânica em pago
representa o custo mensal estimado (USD) de veicular anúncios para todas as palavras-chave da categoria para as quais o domínio ou subdomínio ranqueia
a métrica é calculada como o produto dos valores de etv orgânico e cpc pago e indica o custo de direcionar o volume estimado de tráfego orgânico mensal por meio de publicidade PPC no Google Search
saiba mais sobre como a métrica é calculada neste artigo da central de ajuda

etv
Tipo: number | null

volume de tráfego estimado
tráfego orgânico mensal estimado para o domínio ou subdomínio
calculado como o produto dos valores de CTR (click-through-rate) e de volume de pesquisa de todas as palavras-chave da categoria para as quais o domínio ou subdomínio ranqueia
saiba mais sobre como a métrica é calculada neste artigo da central de ajuda

is_down
Tipo: integer | null

rank caiu
indica quantos elementos ranqueados do destino indicado caíram

is_lost
Tipo: integer | null

elementos ranqueados perdidos
indica quantos elementos ranqueados do destino indicado estavam presentes anteriormente nas SERPs, mas não foram encontrados durante a última verificação

is_new
Tipo: integer | null

número de novos elementos ranqueados
indica quantos novos elementos ranqueados foram encontrados para o destino indicado

is_up
Tipo: integer | null

rank subiu
indica quantos elementos ranqueados do destino indicado subiram

pos_1
Tipo: integer | null

número de SERPs orgânicas em que o domínio ou subdomínio ocupa a posição #1

pos_11_20
Tipo: integer | null

número de SERPs orgânicas em que o domínio ou subdomínio ocupa a posição #11-20

pos_2_3
Tipo: integer | null

número de SERPs orgânicas em que o domínio ou subdomínio ocupa a posição #2-3

pos_21_30
Tipo: integer | null

número de SERPs orgânicas em que o domínio ou subdomínio ocupa a posição #21-30

pos_31_40
Tipo: integer | null

número de SERPs orgânicas em que o domínio ou subdomínio ocupa a posição #31-40

pos_4_10
Tipo: integer | null

número de SERPs orgânicas em que o domínio ou subdomínio ocupa a posição #4-10

pos_41_50
Tipo: integer | null

número de SERPs orgânicas em que o domínio ou subdomínio ocupa a posição #41-50

pos_51_60
Tipo: integer | null

número de SERPs orgânicas em que o domínio ou subdomínio ocupa a posição #51-60

pos_61_70
Tipo: integer | null

número de SERPs orgânicas em que o domínio ou subdomínio ocupa a posição #61-70

pos_71_80
Tipo: integer | null

número de SERPs orgânicas em que o domínio ou subdomínio ocupa a posição #71-80

pos_81_90
Tipo: integer | null

número de SERPs orgânicas em que o domínio ou subdomínio ocupa a posição #81-90

pos_91_100
Tipo: integer | null

número de SERPs orgânicas em que o domínio ou subdomínio ocupa a posição #91-100

month
Tipo: integer | null

mês para o qual os dados são fornecidos

se_type
Tipo: string | null

tipo de mecanismo de busca

year
Tipo: integer | null

ano para o qual os dados são fornecidos

items_count
Tipo: integer | null Formato: int64

o número de resultados retornados no array items

language_code
Tipo: string | null

código de idioma em um array POST

location_code
Tipo: integer | null

código de localização em um array POST

se_type
Tipo: string | null

tipo de mecanismo de busca

target
Tipo: string | null

domínio de destino em um array POST

total_count
Tipo: integer | null Formato: int64

quantidade total de resultados em nosso banco de dados relevantes para a sua solicitação

result_count
Tipo: integer | null Formato: int64

número de elementos no array de resultados

status_code
Tipo: integer | null

código de status da tarefa gerado pelo DataForSEO; pode estar no seguinte intervalo: 10000-60000 você pode encontrar a lista completa dos códigos de resposta aqui

status_message
Tipo: string | null

mensagem informativa da tarefa você pode encontrar a lista completa das mensagens informativas gerais aqui

time
Tipo: string | null

tempo de execução, segundos

tasks_count
Tipo: integer | null Formato: int64

o número de tarefas no array de tarefas

tasks_error
Tipo: integer | null Formato: int64

o número de tarefas no array de tarefas retornadas com erro

time
Tipo: string | null

tempo total de execução, em segundos

version
Tipo: string | null

a versão atual da API
application/json
400

Não foi possível processar a requisição. Verifique os parâmetros da requisição.
401

É necessária uma chave de API da Felo válida.
402

A requisição não pode prosseguir porque um requisito de cobrança não foi atendido.
403

A conta não tem permissão para realizar esta operação.
429

Um limite de requisições ou de gastos foi atingido.
502

O serviço não pôde concluir a requisição.
503

A API ou o serviço de cobrança está temporariamente indisponível.
504

O serviço atingiu o tempo limite ao processar a requisição.
default

Resposta de erro; respostas repassadas do upstream podem usar formatos do provedor

application/json

post/v1/beta/dataforseo/dataforseo_labs/google/historical_rank_overview/live

curl https://openapi.felo.ai/v1/beta/dataforseo/dataforseo_labs/google/historical_rank_overview/live \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '[
  {
    "target": "dataforseo.com",
    "location_code": 2840,
    "language_code": "en",
    "date_from": "2021-01-01",
    "date_to": "2021-03-29"
  }
]'

Mostrar Schema

{
  "version": null,
  "status_code": null,
  "status_message": null,
  "time": null,
  "cost": null,
  "tasks_count": null,
  "tasks_error": null,
  "tasks": [
    {
      "id": null,
      "status_code": null,
      "status_message": null,
      "time": null,
      "cost": null,
      "result_count": null,
      "path": [
        null
      ],
      "data": null,
      "result": [
        {
          "se_type": null,
          "target": null,
          "location_code": null,
          "language_code": null,
          "total_count": null,
          "items_count": null,
          "items": [
            {
              "se_type": null,
              "year": null,
              "month": null,
              "metrics": null
            }
          ]
        }
      ]
    }
  ]
}

Operação bem-sucedida

Visão geral histórica de ranking

AutenticaçãoRequired

DataForSEO

Visão geral histórica de ranking

Referência de preços