POST GET exports/jobStatus

Check the status of an export job

* required

Parameters

Name Type Description
jobID * integer Unique ID of export job

Response Data

If export has records (totalRecords > 0), fileKey and fileExpiration will be returned
Name Type Description
status string One of: Pending, In Progress, Completed, Failed
totalRecords integer Number of records in export. Only returned if status is "Completed".
fileKey guid Unique ID of export file. Only returned if status is "Completed" and export has records.
fileExpiration datetime Timestamp of when file will no longer be available. Only returned if status is "Completed" and export has records.
details string Extra information about the export

Permissions

Method requires the Client Administrator permission

Example Calls

Status: Pending or In Progress

Check again later. Under normal circumstances, jobs will complete within a few minutes.

GET
/exports/jobStatus?jobID=123
cURL
Copy
Response Data

Status: Completed (with no records)

If the totalRecords is 0, no file is created and the process is complete.

GET
/exports/jobStatus?jobID=123
cURL
Copy
Response Data

Status: Completed (with records)

Use the fileKey to retrieve the file by calling exports/getFile. The file will be available until the time specified by fileExpiration.

GET
/exports/jobStatus?jobID=123
cURL
Copy
Response Data

Status: Failed

The job failed to execute. Check the code and errors values to determine the cause. You will have to create the job request again by repeating the original call (i.e. exports/getEmails)

GET
/exports/jobStatus?jobID=123
cURL
Copy
Response Data

API Console

The console uses production data, so BE CAREFUL!
GET
exports/jobStatus
Param Value Type Description
jobID * integer Unique ID of export job
Access token: *