Status & Monitoring
Check Session Status
Check the status of an address import session
GET
Overview
The Check Session Status API allows you to monitor the progress of a previously initiated address import session. This endpoint is useful for tracking long-running import operations and determining when they’ve completed.
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 to check
Notes
- The response includes two main components:
status
: Current state of the session (“PROCESSING”, “COMPLETED”, “FAILED”, etc.)progress
: Detailed metrics about the import operationtotal
: Total number of addresses in the import 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 “Session not found” status and
-1
progress values indicates that the session 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