Skip to main content
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 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.
Valores aceitos para 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.
Campos descritos na estrutura dos datasets podem não aparecer em todas as consultas. A disponibilidade depende da fonte, do documento consultado e do dataset selecionado.

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

Polling recomendado

  1. Inicie a consulta em modo assíncrono.
  2. Guarde o id retornado.
  3. Consulte este endpoint usando o target correspondente.
  4. Enquanto status for queued ou processing, repita a consulta com intervalo progressivo.
  5. Ao receber completed, completed_with_errors ou failed, pare o polling e trate result, errors e datasets_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:
Para ver conceitos, filtros e interpretação dos campos, consulte:

Listar histórico

Liste consultas anteriores com filtros e paginação.

Histórico de consultas

Entenda status por dataset, custos, estornos e erros.