v0.2.0-beta

OpenAPI 3.1.0

Configurar tarefas de ‘Search Volume’

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/keywords_data/bing/search_volume/task_post

Configurar tarefas de ‘Search Volume’

Enfileira uma tarefa de volume de pesquisa do Bing, retornando um id de tarefa. Encapsulado no envelope do DataForSEO: dados em tasks[0].result, resultado em tasks[0].status_code — uma requisição rejeitada ainda retorna HTTP 200. Recupere com get_dataforseo_keywords_bing_search_volume_fetch.

Referência de preços

Medição: Custo da resposta reportado.
Estimativa de referência por requisição: USD 0.06.
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)[]
- 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 12 meses
  valor mínimo: 24 meses a partir da data de hoje
  se o endpoint Status retornar false no campo actual_data, date_from pode ser definido como o mês retrasado e os anteriores;
  se o endpoint Status retornar true no campo actual_data, date_from pode ser definido como o último mês e os anteriores;
  formato de data: "yyyy-mm-dd"
  exemplo:
  "2020-01-01"
  
  Observação: não recomendamos usar um intervalo de tempo personalizado para datas do último ano
- date_to
  Tipo: string | null
  
  data final do intervalo de tempo
  campo opcional
  se você não especificar este campo, os dados serão fornecidos para os últimos 12 meses;
  valor mínimo: dois anos a partir da data de hoje;
  valor máximo: um mês a partir da data de hoje;
  observação: não recomendamos usar um intervalo de tempo personalizado para datas do último ano;
  formato de data: "yyyy-mm-dd"
  exemplo:
  "2020-03-15"
  
  Observação: não recomendamos usar um intervalo de tempo personalizado para datas do último ano
- device
  Tipo: string | null
  
  tipo de dispositivo
  campo opcional
  especifique este campo para obter os dados de um tipo de dispositivo específico; valores possíveis: all, mobile, desktop, tablet
  valor padrão: all
- keywords
  Tipo: array string[]
  
  palavras-chave
  campo obrigatório
  O número máximo de palavras-chave que você pode especificar: 1000
  O número máximo de caracteres para cada palavra-chave: 100
  as palavras-chave especificadas serão convertidas para minúsculas, os dados serão fornecidos em um array separado
  
  saiba mais sobre as regras e limitações dos campos keyword e keywords nas APIs do DataForSEO neste artigo da Central de Ajuda
- language_code
  Tipo: string
  
  código de idioma do mecanismo de busca
  campo obrigatório se você não especificar language_name
  se você usar este campo, não precisa especificar language_name
  idiomas compatíveis:
  en, fr, de
- language_name
  Tipo: string
  
  nome completo do idioma do mecanismo de busca
  campo obrigatório se você não especificar language_code
  se você usar este campo, não precisa especificar language_code
  idiomas compatíveis:
  English, French, German
- location_code
  Tipo: integer
  
  código do local do mecanismo de busca
  campo obrigatório se você não especificar location_name ou location_coordinate
  se você usar este campo, não precisa especificar location_name ou location_coordinate
  você pode receber a lista de locais disponíveis dos mecanismos de busca com seu location_code fazendo uma requisição separada para https://api.dataforseo.com/v3/keywords_data/bing/locations
  exemplo:
  2840
- location_coordinate
  Tipo: string
  
  coordenadas GPS de um local
  campo obrigatório se você não especificar location_name ou location_code
  se você usar este campo, não precisa especificar location_name ou location_code
  o parâmetro location_coordinate deve ser especificado no formato "latitude,longitude"
  os dados serão fornecidos para o país ao qual as coordenadas especificadas pertencem
  exemplo:
  52.6178549,-155.352142
- location_name
  Tipo: string
  
  nome completo do local do mecanismo de busca
  campo obrigatório se você não especificar location_code ou location_coordinate
  se você usar este campo, não precisa especificar location_code ou location_coordinate
  você pode receber a lista de locais disponíveis do mecanismo de busca com seu location_name fazendo uma requisição separada para https://api.dataforseo.com/v3/keywords_data/bing/locations
  exemplo:
  London,England,United Kingdom
- pingback_url
  Tipo: string | null
  
  URL de notificação de uma tarefa concluída
  campo opcional
  quando uma tarefa é concluída, notificaremos você por meio de uma requisição GET enviada para a URL que você especificou
  você pode usar a string ‘$id’ como variável $id e ‘$tag’ como variável $tag codificada para URL. Definiremos os valores necessários antes de enviar a requisição
  exemplo:
  http://your-server.com/pingscript?id=$id
  http://your-server.com/pingscript?id=$id&tag=$tag
  Observação: caracteres especiais em pingback_url serão codificados para URL;
  ou seja, o caractere # será codificado como %23
  
  saiba mais na nossa Central de Ajuda
- postback_url
  Tipo: string | null
  
  URL para envio dos resultados da tarefa
  campo opcional
  quando a tarefa for concluída, enviaremos uma requisição POST com os resultados compactados no formato gzip para o postback_url que você especificou
  você pode usar a string ‘$id’ como variável $id e ‘$tag’ como variável $tag codificada para URL. Definiremos os valores necessários antes de enviar a requisição.
  exemplo:
  http://your-server.com/postbackscript?id=$id
  http://your-server.com/postbackscript?id=$id&tag=$tag
  Observação: caracteres especiais em postback_url serão codificados para URL;
  ou seja, o caractere # será codificado como %23
  
  saiba mais na nossa Central de Ajuda
- search_partners
  Tipo: boolean | null
  
  tipo de parceiros de pesquisa do Bing
  campo opcional
  se você especificar true, os resultados serão entregues para redes próprias, operadas e sindicadas do Bing, Yahoo, AOL e sites parceiros que hospedam as pesquisas do Bing, AOL e Yahoo.
  valor padrão: false - os resultados são retornados para as redes de pesquisa do Bing, AOL e Yahoo
- sort_by
  Tipo: string | null
  
  parâmetros de ordenação dos resultados
  campo opcional
  use estes parâmetros para ordenar os resultados por search_volume, cpc, competition ou relevance em ordem decrescente
  valor padrão: relevance
- 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

Respostas

200
Tipo: object | null · Response36Afe1097B20_KeywordsDataBingSearchVolumeTaskPostResponseInfo
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_KeywordsDataBingSearchVolumeTaskPostTaskInfo
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: object | null

array de resultados
nesse caso, o valor será null

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/keywords_data/bing/search_volume/task_post

curl https://openapi.felo.ai/v1/beta/dataforseo/keywords_data/bing/search_volume/task_post \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '[
  {
    "location_name": "United States",
    "language_name": "English",
    "keywords": [
      "average page rpm adsense",
      "adsense blank ads how long",
      "leads and prospects"
    ]
  }
]'

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": null
    }
  ]
}

Operação bem-sucedida

Configurar tarefas de ‘Search Volume’

AutenticaçãoRequired

DataForSEO

Configurar tarefas de ‘Search Volume’

Referência de preços