Summarize recent API bulk imports by day

Summarize this account's API bulk imports from the last 7 days: for each day, how many batches and contacts are still outstanding and how many completed. Only imports submitted through POST /import/bulk_import are counted; imports started from the app's import tool or by integrations never appear here (use GET /import/history for those). There is no per-batch or per-contact detail and no error information, so this cannot explain why an import failed; for one batch use GET /import/info with its batchId. Both arrays are empty when nothing was imported through the API in the last 7 days. A batch that stalled and has a failed chunk is left out of outstanding.

🧠

Add a short delay between creating a bulk import and calling for it's status

If this endpoint is called immediately (less than a second) after a bulk import call, the status in the return may be false (a boolean), because the system has not yet set a status on the batch.

After using the POST endpoint to send bulk data, you can use this endpoint to monitor progress. This endpoint only returns aggregate progress data.  The response is a JSON map of daily summaries of outstanding and recentlyCompleted batch jobs. Recently completed is a rolling window of the last seven days.

If you want specific details, register for a callback when sending the bulk job OR save the batchId and use the info endpoint.

{
  "outstanding":[
    {"forDate":"2021-06-01","batches":"333","contacts":"83250"}
  ],
  "recentlyCompleted":[
    {"forDate":"2021-06-01","batches":"17","contacts":"4250"},
    {"forDate":"2021-06-02","batches":"50","contacts":"12500"}
  ]
}
Response

Language
Credentials
Header
URL
LoadingLoading…
Response
Choose an example:
application/json