Consultar estado de job batch
Referencia API
Consultar estado de job batch
Consulta el estado, progreso y contadores de filas de un job de importación batch por jobId (entidades, transacciones y user events) en la API gu1.
GET
Consultar estado de job batch
Endpoint
202 con un jobId. Resuelve el tipo de job automáticamente y hace lookup directo — no recorre el histórico completo.
Autenticación
transactions:create, entities:bulk_import, events:create.
Query parameters
Respuestas HTTP
Flujo de polling recomendado
- Upload (entidades, transacciones o user events) → guardar
jobIddel202. - Poll
GET /batch-import/jobs/{jobId}cada 2–5 segundos. - Detener cuando
statussea terminal:completed,failed,cancelledointerrupted. - Si necesitan detalle fila a fila, llamar con
?include=failureso 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:
- Entidades: Entity batch failures
- Transacciones: Transaction batch failures
- User events: User-event batch failures
failures es un array vacío (failuresTotal: 0).
Ver también: Bulk imports overview, Unified history.