v0.2.0-beta

OpenAPI 3.1.0

Métricas agregadas de LLM Mentions em tempo real

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/ai_optimization/llm_mentions/aggregated_metrics/live

Métricas agregadas de LLM Mentions em tempo real

Com que frequência os assistentes mencionam seu alvo, em totais e não em respostas individuais: total e items. ⚠️ target é um array de objetos, cada um {"domain": "..."} ou {"keyword": "..."}; uma string simples é rejeitada por tipo incorreto e um array de strings com 'Each target item must be an object'. Os campos de filtro vêm de get_dataforseo_ai_llm_mentions_available_filters. Encapsulado no envelope do DataForSEO: dados em tasks[0].result, resultado em tasks[0].status_code — uma requisição rejeitada ainda retorna HTTP 200. Este é o número principal de visibilidade; post_dataforseo_ai_llm_mentions_search_live mostra as respostas por trás dele, e post_dataforseo_ai_llm_mentions_cross_metrics_live compara vários alvos de uma vez.

Referência de preços

Medição: Custo da resposta reportado.
Estimativa de referência por requisição: USD 0.101.
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

obrigatório

application/json

Tipo: array object[]
- target
  Tipo: array object[]
  obrigatório
  
  array de objetos contendo entidades de destino campo obrigatório você pode especificar até 10 entidades (objetos) no campo target uma entidade de destino pode conter um domínio ou uma palavra-chave e parâmetros relacionados. Exemplos: array targets com uma entidade de domínio [{"domain": "en.wikipedia.org", "search_filter": "exclude"}] array targets com uma entidade de palavra-chave [{"keyword": "bmw", "search_scope": ["question"], "match_type ": "partial_match"}] array targets com várias entidades [{"domain": "en.wikipedia.org", "search_filter": "exclude"}, {"keyword": "bmw", "match_type ": "partial_match", "search_scope": ["answer"]}]
  
  domain
  Tipo: string
  obrigatório
  
  domínio de destino campo obrigatório se você não especificar keyword você pode especificar até 63 caracteres no campo domain; um domínio deve ser especificado sem https:// e www.
  
  include_subdomains
  Tipo: boolean
  
  indica se os subdomínios do domínio de destino serão incluídos na pesquisa campo opcional se definido como true, os subdomínios serão incluídos na pesquisa valor padrão: false
  
  keyword
  Tipo: string
  
  palavra-chave de destino campo obrigatório se você não especificar domain você pode especificar até 250 caracteres no campo keyword todos os %## serão decodificados (o caractere ‘+’ será decodificado como espaço) se precisar usar o caractere “%” na sua keyword, especifique-o como “%25”; se precisar usar o caractere “+” na sua keyword, especifique-o como “%2B”saiba mais sobre as regras e limitações dos campos keyword e keywords nas APIs do DataForSEO neste artigo da Central de Ajuda
  
  match_type
  Tipo: string
  
  tipo de correspondência da palavra-chave de destino campo opcional word_match - pesquisa de texto completo por termos que correspondem à palavra-chave semente especificada com palavras adicionais incluídas antes, depois ou dentro da frase-chave (por exemplo, pesquisar por “light” retornará resultados com “light bulb”, “light switch”); partial_match - pesquisa de substring que encontra todas as instâncias contendo a sequência de caracteres especificada, mesmo que apareça dentro de uma palavra mais longa (por exemplo, pesquisar por “light” retornará resultados com “lighting”, “highlight”); valores possíveis: word_match, partial_match valor padrão: word_match
  
  search_filter
  Tipo: string
  
  Filtro de pesquisa de entidade: incluir ou excluir; o padrão é incluir.
  
  search_scope
  Tipo: array string[]
  
  Escopo da pesquisa. Entidades de domínio: any, sources, search_results. Entidades de palavra-chave: any, question, answer, brand_entities, fan_out_queries. Padrão: any.
- initial_dataset_filters
  Tipo: array
  
  array de expressões de filtro aplicadas antes da agregação campo opcional você pode usar este array para filtrar expressões aplicadas ao banco de dados bruto de menções antes da agregação, a fim de limitar as linhas que contribuem para o resultado;você pode adicionar vários filtros de uma vez (máximo de 8 filtros) você deve definir um operador lógico e, ou entre as condições os seguintes operadores são suportados: =, , in, not_in, like, not_like, ilike, not_ilike, match, not_match você pode usar o operador % com like e not_like para corresponder a qualquer string de zero ou mais caracteres exemplo: ["ai_search_volume",">","1000"]a lista completa de filtros possíveis está disponível aqui. saiba mais sobre os filtros do conjunto de dados inicial neste artigo da central de ajuda.
- internal_list_limit
  Tipo: integer
  
  número máximo de elementos dentro de arrays internos campo opcional você pode usar este campo para limitar o número de elementos nos seguintes arrays: sources_domain search_results_domain valor mínimo: 1 valor máximo: 20 valor padrão: 10
- language_code
  Tipo: string
  
  código do idioma de pesquisa campo opcional se você usar este campo, não precisa especificar language_name; você pode obter a lista de idiomas disponíveis do mecanismo de busca e seus language_code fazendo uma requisição separada para https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages valor padrão: en Observação: os dados do chat_gpt estão disponíveis apenas para en
- language_name
  Tipo: string
  
  nome completo do idioma de pesquisa campo opcional se você usar este campo, não precisa especificar language_code; se você não especificar este campo, o language_code com valor en será usado por padrão; você pode obter a lista de idiomas disponíveis do mecanismo de busca e seus language_name fazendo uma requisição separada para https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages Observação: os dados do chat_gpt estão disponíveis apenas em inglês
- location_code
  Tipo: integer
  
  código do local de pesquisa campo opcional se você usar este campo, não precisa especificar location_name você pode obter a lista de locais disponíveis do mecanismo de busca e seus location_code fazendo uma requisição separada para https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages valor padrão: 2840 Observação: os dados do chat_gpt estão disponíveis apenas para 2840
- location_name
  Tipo: string
  
  nome completo do local de pesquisa campo opcional se você usar este campo, não precisa especificar location_code se você não especificar este campo, o location_code com valor 2840 será usado por padrão; você pode obter a lista de locais disponíveis do mecanismo de busca e seus location_name fazendo uma requisição separada para https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages Observação: os dados do chat_gpt estão disponíveis apenas para Estados Unidos
- platform
  Tipo: string
  
  plataforma de destino campo opcional valores possíveis: chat_gpt, google valor padrão: google Observação: os dados retornados dependem da plataforma selecionada Observação nº 2: os dados do chat_gpt estão disponíveis apenas para os Estados Unidos e o inglês
- tag
  Tipo: string
  
  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 tag especificado no objeto data da resposta

Respostas

200
Tipo: object

Resposta bem-sucedida
cost
Tipo: number

custo total das tarefas, USD

status_code
Tipo: integer

código de status geral você pode encontrar a lista completa dos códigos de resposta aqui Observação: recomendamos fortemente projetar um sistema necessário para lidar com condições excepcionais ou de erro relacionadas

status_message
Tipo: string

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

tasks
Tipo: array string[]

array de tarefas

tasks_count
Tipo: integer

o número de tarefas no array de tarefas

tasks_error
Tipo: integer

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

tasks.cost
Tipo: number

custo da tarefa, USD

tasks.data
Tipo: object

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

tasks.id
Tipo: string

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

tasks.path
Tipo: array string[]

caminho da URL

tasks.result
Tipo: array string[]

array de resultados

tasks.result_count
Tipo: integer

número de elementos no array de resultados

tasks.result.items
Tipo: array string[]

array de resultados de páginas individuais contendo métricas detalhadas de menções para cada uma das principais páginas encontradas neste caso, é igual a null

tasks.result.total
Tipo: object

resumo das métricas agregadas de menções contém métricas gerais agregadas de menções de LLM em todos os domínios encontrados, agrupadas por várias dimensões

tasks.result.total.brand_entities_category
Tipo: array string[]

dados sobre entidades de marca relevantes para o destino array de objetos contendo dados sobre categorias de entidades de marca que aparecem nos resultados de pesquisa relacionados a consultas de LLM

tasks.result.total.brand_entities_category.ai_search_volume
Tipo: integer

taxa atual de volume de pesquisa de IA de uma palavra-chave saiba mais sobre esta métrica aqui

tasks.result.total.brand_entities_category.impressions
Tipo: integer

taxa atual de impressões de IA de uma palavra-chave

tasks.result.total.brand_entities_category.key
Tipo: string

identificador de agrupamento o identificador específico da dimensão de agrupamento neste caso, o campo exibe uma categoria de entidade de marca encontrada

tasks.result.total.brand_entities_category.mentions
Tipo: integer

contagem total de menções de LLM o número de vezes que a palavra-chave ou o domínio de destino foram mencionados em relação ao domínio específico

tasks.result.total.brand_entities_category.type
Tipo: string

tipo do elemento = 'group_element'

tasks.result.total.brand_entities_title
Tipo: array string[]

dados sobre entidades de marca relevantes para o destino array de objetos contendo dados sobre títulos de entidades de marca que aparecem nos resultados de pesquisa relacionados a consultas de LLM

tasks.result.total.brand_entities_title.ai_search_volume
Tipo: integer

taxa atual de volume de pesquisa de IA de uma palavra-chave saiba mais sobre esta métrica aqui

tasks.result.total.brand_entities_title.impressions
Tipo: integer

taxa atual de impressões de IA de uma palavra-chave

tasks.result.total.brand_entities_title.key
Tipo: string

identificador de agrupamento o identificador específico da dimensão de agrupamento neste caso, o campo exibe um título de entidade de marca encontrado

tasks.result.total.brand_entities_title.mentions
Tipo: integer

contagem total de menções de LLM o número de vezes que a palavra-chave ou o domínio de destino foram mencionados em relação ao domínio específico

tasks.result.total.brand_entities_title.type
Tipo: string

tipo do elemento = 'group_element'

tasks.result.total.language
Tipo: array string[]

agrupamento por idioma array de objetos contendo métricas de menções segmentadas pelo idioma do conteúdo

tasks.result.total.language.ai_search_volume
Tipo: integer

taxa atual de volume de pesquisa de IA de uma palavra-chave saiba mais sobre esta métrica aqui

tasks.result.total.language.impressions
Tipo: integer

taxa atual de impressões de IA de uma palavra-chave

tasks.result.total.language.key
Tipo: string

identificador de agrupamento o identificador específico da dimensão de agrupamento

tasks.result.total.language.mentions
Tipo: integer

contagem total de menções de LLM o número de vezes que a palavra-chave ou o domínio de destino foram mencionados em relação a esta chave de agrupamento específica

tasks.result.total.language.type
Tipo: string

tipo do elemento = 'group_element'

tasks.result.total.location
Tipo: array string[]

agrupamento por localização array de objetos contendo métricas de menções segmentadas por localização geográfica

tasks.result.total.location.ai_search_volume
Tipo: integer

taxa atual de volume de pesquisa de IA de uma palavra-chave saiba mais sobre esta métrica aqui

tasks.result.total.location.impressions
Tipo: integer

taxa atual de impressões de IA de uma palavra-chave

tasks.result.total.location.key
Tipo: string

identificador de agrupamento o identificador específico da dimensão de agrupamento

tasks.result.total.location.mentions
Tipo: integer

contagem total de menções de LLM o número de vezes que a palavra-chave ou o domínio de destino foram mencionados em relação a esta chave de agrupamento específica

tasks.result.total.location.type
Tipo: string

tipo do elemento = 'group_element'

tasks.result.total.platform
Tipo: array string[]

agrupamento por plataforma array de elementos de grupo contendo métricas de menções segmentadas por plataforma de IA

tasks.result.total.platform.ai_search_volume
Tipo: integer

taxa atual de volume de pesquisa de IA de uma palavra-chave saiba mais sobre esta métrica aqui

tasks.result.total.platform.impressions
Tipo: integer

taxa atual de impressões de IA de uma palavra-chave

tasks.result.total.platform.key
Tipo: string

identificador de agrupamento o identificador específico da dimensão de agrupamento

tasks.result.total.platform.mentions
Tipo: integer

contagem total de menções de LLM o número de vezes que a palavra-chave ou o domínio de destino foram mencionados em relação a esta chave de agrupamento específica

tasks.result.total.platform.type
Tipo: string

tipo do elemento = 'group_element'

tasks.result.total.search_results_domain
Tipo: array string[]

principais domínios de resultados de pesquisa encontrados relevantes para o destino array de objetos contendo dados sobre os principais domínios que aparecem nos resultados de pesquisa relacionados a consultas de LLM

tasks.result.total.search_results_domain.ai_search_volume
Tipo: integer

taxa atual de volume de pesquisa de IA de uma palavra-chave saiba mais sobre esta métrica aqui

tasks.result.total.search_results_domain.impressions
Tipo: integer

taxa atual de impressões de IA de uma palavra-chave

tasks.result.total.search_results_domain.key
Tipo: string

identificador de agrupamento o identificador específico da dimensão de agrupamento neste caso, o campo exibe um nome de domínio encontrado

tasks.result.total.search_results_domain.mentions
Tipo: integer

contagem total de menções de LLM o número de vezes que a palavra-chave ou o domínio de destino foram mencionados em relação ao domínio específico

tasks.result.total.search_results_domain.type
Tipo: string

tipo do elemento = 'group_element'

tasks.result.total.sources_domain
Tipo: array string[]

principais domínios de origem encontrados relevantes para o destino array de objetos contendo dados sobre os principais domínios citados como fontes nas respostas de LLM

tasks.result.total.sources_domain.ai_search_volume
Tipo: integer

taxa atual de volume de pesquisa de IA de uma palavra-chave saiba mais sobre esta métrica aqui

tasks.result.total.sources_domain.impressions
Tipo: integer

taxa atual de impressões de IA de uma palavra-chave

tasks.result.total.sources_domain.key
Tipo: string

identificador de agrupamento o identificador específico da dimensão de agrupamento neste caso, o campo exibe um nome de domínio encontrado

tasks.result.total.sources_domain.mentions
Tipo: integer

contagem total de menções de LLM o número de vezes que a palavra-chave ou o domínio de destino foram mencionados em relação ao domínio específico

tasks.result.total.sources_domain.type
Tipo: string

tipo do elemento = 'group_element'

tasks.status_code
Tipo: integer

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

tasks.status_message
Tipo: string

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

tasks.time
Tipo: string

tempo de execução, segundos

time
Tipo: string

tempo de execução, segundos

version
Tipo: string

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/ai_optimization/llm_mentions/aggregated_metrics/live

curl https://openapi.felo.ai/v1/beta/dataforseo/ai_optimization/llm_mentions/aggregated_metrics/live \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '[
  {
    "target": [
      {
        "domain": "en.wikipedia.org"
      }
    ]
  }
]'

Mostrar Schema

{
  "version": "string",
  "status_code": 1,
  "status_message": "string",
  "time": "string",
  "cost": 1,
  "tasks_count": 1,
  "tasks_error": 1,
  "tasks": [
    "string"
  ],
  "tasks.id": "string",
  "tasks.status_code": 1,
  "tasks.status_message": "string",
  "tasks.time": "string",
  "tasks.cost": 1,
  "tasks.result_count": 1,
  "tasks.path": [
    "string"
  ],
  "tasks.data": {},
  "tasks.result": [
    "string"
  ],
  "tasks.result.total": {},
  "tasks.result.total.location": [
    "string"
  ],
  "tasks.result.total.location.type": "string",
  "tasks.result.total.location.key": "string",
  "tasks.result.total.location.mentions": 1,
  "tasks.result.total.location.ai_search_volume": 1,
  "tasks.result.total.location.impressions": 1,
  "tasks.result.total.language": [
    "string"
  ],
  "tasks.result.total.language.type": "string",
  "tasks.result.total.language.key": "string",
  "tasks.result.total.language.mentions": 1,
  "tasks.result.total.language.ai_search_volume": 1,
  "tasks.result.total.language.impressions": 1,
  "tasks.result.total.platform": [
    "string"
  ],
  "tasks.result.total.platform.type": "string",
  "tasks.result.total.platform.key": "string",
  "tasks.result.total.platform.mentions": 1,
  "tasks.result.total.platform.ai_search_volume": 1,
  "tasks.result.total.platform.impressions": 1,
  "tasks.result.total.sources_domain": [
    "string"
  ],
  "tasks.result.total.sources_domain.type": "string",
  "tasks.result.total.sources_domain.key": "string",
  "tasks.result.total.sources_domain.mentions": 1,
  "tasks.result.total.sources_domain.ai_search_volume": 1,
  "tasks.result.total.sources_domain.impressions": 1,
  "tasks.result.total.search_results_domain": [
    "string"
  ],
  "tasks.result.total.search_results_domain.type": "string",
  "tasks.result.total.search_results_domain.key": "string",
  "tasks.result.total.search_results_domain.mentions": 1,
  "tasks.result.total.search_results_domain.ai_search_volume": 1,
  "tasks.result.total.search_results_domain.impressions": 1,
  "tasks.result.total.brand_entities_title": [
    "string"
  ],
  "tasks.result.total.brand_entities_title.type": "string",
  "tasks.result.total.brand_entities_title.key": "string",
  "tasks.result.total.brand_entities_title.mentions": 1,
  "tasks.result.total.brand_entities_title.ai_search_volume": 1,
  "tasks.result.total.brand_entities_title.impressions": 1,
  "tasks.result.total.brand_entities_category": [
    "string"
  ],
  "tasks.result.total.brand_entities_category.type": "string",
  "tasks.result.total.brand_entities_category.key": "string",
  "tasks.result.total.brand_entities_category.mentions": 1,
  "tasks.result.total.brand_entities_category.ai_search_volume": 1,
  "tasks.result.total.brand_entities_category.impressions": 1,
  "tasks.result.items": [
    "string"
  ]
}

Resposta bem-sucedida

Métricas agregadas de LLM Mentions em tempo real

AutenticaçãoRequired

DataForSEO

Métricas agregadas de LLM Mentions em tempo real

Referência de preços