Skip to main content
GET
Consultar estado de job batch

Endpoint

Usen esta ruta como endpoint canónico de polling después de cualquier upload bulk que devuelva 202 con un jobId. Resuelve el tipo de job automáticamente y hace lookup directo — no recorre el histórico completo.

Autenticación

Requiere al menos uno de: transactions:create, entities:bulk_import, events:create.

Query parameters

Respuestas HTTP

Flujo de polling recomendado

  1. Upload (entidades, transacciones o user events) → guardar jobId del 202.
  2. Poll GET /batch-import/jobs/{jobId} cada 2–5 segundos.
  3. Detener cuando status sea terminal: completed, failed, cancelled o interrupted.
  4. Si necesitan detalle fila a fila, llamar con ?include=failures o usar el endpoint de failures por tipo (ver Bulk imports overview).
Para listar jobs recientes (estilo dashboard), usen Unified history. Para polling de un job puntual, preferir este endpoint.

JSON (default — solo status)

boolean
Siempre true cuando el job existe.
string
Identificador del job devuelto en el upload.
string
entity_batch (alias entity_automatic), transaction_batch o user_event_batch.
string
queued, running, completed, failed, cancelled o interrupted. Durante una cancelación puede seguir en running con metadata.batchCancelRequested.
number | null
Total de filas/ítems del job.
number | null
Cantidad procesada con éxito.
number | null
Cantidad de filas fallidas.
number | null
Cantidad omitida (p. ej. taxId duplicado en entidades).
string | null
Último heartbeat del worker (ISO 8601).
string | null
Expiración del lease del worker (ISO 8601).
string | null
Error del worker truncado cuando el job falló a nivel job.
string
Creación del job (ISO 8601).
string | null
Finalización cuando es terminal (ISO 8601).
object | null
Metadata del job (p. ej. fileName, modo de import).
object | null
Presente cuando status es failed y abortó el job completo. Incluye code estable y message — ver Failure codes.

JSON con ?include=failures

Mismo contrato que los endpoints JSON de failures por tipo: Sin fallos por fila, failures es un array vacío (failuresTotal: 0). Ver también: Bulk imports overview, Unified history.