GET
/
v1
/
session
/
batch
/
status
curl --request GET \
  --url https://api.findloka.com/v1/session/batch/status \
  --header 'Authorization: <authorization>'
{
  "status": "PROCESSING",
  "progress": {
    "total": 50,
    "processed": 40,
    "successful": 35,
    "failed": 5
  }
}

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

Authorization
string
required

Your API key for authentication

Query Parameters

session_id
string
required

The unique identifier of the import session

batch_id
string
required

The unique identifier of the specific batch to check

{
  "status": "PROCESSING",
  "progress": {
    "total": 50,
    "processed": 40,
    "successful": 35,
    "failed": 5
  }
}

Notes

  • The response includes two main components:
    • status: Current state of the batch (“PROCESSING”, “COMPLETED”, “FAILED”, etc.)
    • progress: Detailed metrics about the batch processing
      • total: Total number of addresses in this batch
      • processed: Number of addresses that have been processed so far
      • successful: Number of addresses successfully imported
      • failed: 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 equals total)
  • Once processing is complete, the sum of successful and failed will equal total
  • For overall session progress, use the Check Session Status endpoint