Skip to main content
GET
Poll the progress of a connection tx-sync batch

Authorizations

X-API-KEY
string
header
required

Authorization method required to allow user to access the api endpoints.

Query Parameters

batch_id
string
required

Response

200 - application/json
batch_id
string<uuid>
required
running
number
required

Connections whose row is currently marked running.

Example:

2

succeeded
number
required

Connections that finished this batch successfully.

Example:

3

failed
number
required

Connections whose job for this batch failed (after retries).

Example:

0

transactions_upserted
number
required

Total transactions upserted across the successfully-synced connections in this batch.

Example:

12

pending
number
required

Jobs for this batch still in-flight in the queue (waiting, delayed or active). Independent of per-connection rows.

Example:

1

complete
boolean
required

True once no job for this batch remains in-flight (pending === 0). The authoritative "batch is done" signal to poll on.

Example:

false

Last modified on July 30, 2026