Skip to main content
GET
Consultar status do job batch

Endpoint

Use esta rota como endpoint canônico de polling após qualquer upload bulk que retorne 202 com um jobId. Resolve o tipo de job automaticamente e faz lookup direto — não percorre o histórico completo.

Autenticação

Requer pelo menos um de: transactions:create, entities:bulk_import, events:create.

Query parameters

Respostas HTTP

Fluxo de polling recomendado

  1. Upload (entidades, transações ou user events) → guardar jobId do 202.
  2. Poll GET /batch-import/jobs/{jobId} a cada 2–5 segundos.
  3. Parar quando status for terminal: completed, failed, cancelled ou interrupted.
  4. Se precisarem de detalhe linha a linha, chamar com ?include=failures ou usar o endpoint de failures por tipo (ver Bulk imports overview).
Para listar jobs recentes (estilo dashboard), use Unified history. Para polling de um job específico, prefira este endpoint.

JSON (default — só status)

boolean
Sempre true quando o job existe.
string
Identificador do job retornado no upload.
string
entity_batch (alias entity_automatic), transaction_batch ou user_event_batch.
string
queued, running, completed, failed, cancelled ou interrupted. Durante cancelamento pode permanecer em running com metadata.batchCancelRequested.
number | null
Total de linhas/itens do job.
number | null
Quantidade processada com sucesso.
number | null
Quantidade de linhas com falha.
number | null
Quantidade ignorada (ex.: taxId duplicado em entidades).
string | null
Último heartbeat do worker (ISO 8601).
string | null
Expiração do lease do worker (ISO 8601).
string | null
Erro do worker truncado quando o job falhou em nível de job.
string
Criação do job (ISO 8601).
string | null
Conclusão quando terminal (ISO 8601).
object | null
Metadata do job (ex.: fileName, modo de import).
object | null
Presente quando status é failed e o job inteiro abortou. Inclui code estável e message — ver Failure codes.

JSON com ?include=failures

Mesmo contrato dos endpoints JSON de failures por tipo: Sem falhas por linha, failures é array vazio (failuresTotal: 0). Ver também: Bulk imports overview, Unified history.