Resultado assíncrono
Consultas
Resultado assíncrono
Consulte o andamento, resultado final e histórico técnico de uma consulta assíncrona.
GET
Resultado assíncrono
Retorna o status atual e os dados disponíveis de uma consulta iniciada anteriormente em modo assíncrono.
Use este endpoint para implementar polling após receber o
Valores aceitos para
Estrutura de
Estrutura de
Estrutura de
Estrutura de
Cada chave representa um dataset solicitado.
Estrutura de
Estrutura de
O campo
Estrutura de
Objeto indexado pelo ID do dataset.
Estrutura de
Objeto indexado pelo ID do dataset. Cada chave contém o retorno final do dataset correspondente.
Para ver conceitos, filtros e interpretação dos campos, consulte:
id de uma consulta com status queued ou processing.
Esse endpoint é voltado para polling logo após iniciar uma consulta assíncrona.
Para consultar histórico armazenado fora da janela curta de polling, use
GET /v1/search/history e GET /v1/search/history/{history_id} com escopo history.Parâmetros
string
required
Tipo da consulta assíncrona que será detalhada.
target:
string
required
ID retornado ao iniciar a consulta assíncrona.
Resposta
integer
required
Código da resposta da API.
string
required
Mensagem descritiva da resposta.
object
Objeto principal com o status, dados da consulta, custos, tempos, erros e retorno dos datasets.
Estrutura de result
Status da consulta
Trate
completed, completed_with_errors e failed como status finais.Estrutura de query
Estrutura de cost
Estrutura de cost.datasets
Cada chave representa um dataset solicitado.
Estrutura de timing
Estrutura de errors
O campo errors retorna um objeto indexado pelo ID do dataset quando alguma base falha.
Estrutura de datasets_status
Objeto indexado pelo ID do dataset.
Estrutura de result.result
Objeto indexado pelo ID do dataset. Cada chave contém o retorno final do dataset correspondente.
Respostas esperadas
Janela de leitura
O resultado assíncrono fica disponível para leitura por uma janela limitada após a criação da consulta. Atualmente, a janela de leitura é de aproximadamente 30 minutos. Após esse período, a API pode retornar404.
Polling recomendado
- Inicie a consulta em modo assíncrono.
- Guarde o
idretornado. - Consulte este endpoint usando o
targetcorrespondente. - Enquanto
statusforqueuedouprocessing, repita a consulta com intervalo progressivo. - Ao receber
completed,completed_with_errorsoufailed, pare o polling e trateresult,errorsedatasets_status.
Evite polling agressivo. Para consultas com múltiplos datasets ou processos, use intervalos maiores para reduzir carga desnecessária.
Relação com histórico
O histórico de consultas usa o mesmo registro técnico gerado pela consulta assíncrona. Este endpoint detalha um item específico dentro da janela curta de polling. Para histórico completo da conta, use:Listar histórico
Liste consultas anteriores com filtros e paginação.
Histórico de consultas
Entenda status por dataset, custos, estornos e erros.

