Status & Monitoring
Check Batch Status
Check the status of a specific address import batch
GET
Overview
The Check Batch Status API allows you to monitor the progress of a specific batch within an address import session. This endpoint is useful for tracking individual batches in multi-batch import operations.
To obtain an API key, please contact our sales team.
Authorization
Your API key for authentication
Query Parameters
The unique identifier of the import session
The unique identifier of the specific batch to check
Notes
- The response includes two main components:
status
: Current state of the batch (“PROCESSING”, “COMPLETED”, “FAILED”, etc.)progress
: Detailed metrics about the batch processingtotal
: Total number of addresses in this batchprocessed
: Number of addresses that have been processed so farsuccessful
: Number of addresses successfully importedfailed
: Number of addresses that failed to import
- A response with “Batch not found” status and
-1
progress values indicates that the batch doesn’t exist - You should poll this endpoint periodically until status changes to “COMPLETED” or all addresses have been processed (
processed
equalstotal
) - Once processing is complete, the sum of
successful
andfailed
will equaltotal
- For overall session progress, use the Check Session Status endpoint