Consultar status do job batch
Referência API
Consultar status do job batch
Consulte status, progresso e contadores de linhas de um job de importação batch por jobId (entidades, transações e user events) na API batch gu1.
GET
Consultar status do job batch
Endpoint
202 com um jobId. Resolve o tipo de job automaticamente e faz lookup direto — não percorre o histórico completo.
Autenticação
transactions:create, entities:bulk_import, events:create.
Query parameters
Respostas HTTP
Fluxo de polling recomendado
- Upload (entidades, transações ou user events) → guardar
jobIddo202. - Poll
GET /batch-import/jobs/{jobId}a cada 2–5 segundos. - Parar quando
statusfor terminal:completed,failed,cancelledouinterrupted. - Se precisarem de detalhe linha a linha, chamar com
?include=failuresou 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:
- Entidades: Entity batch failures
- Transações: Transaction batch failures
- User events: User-event batch failures
failures é array vazio (failuresTotal: 0).
Ver também: Bulk imports overview, Unified history.