When you need to export a large amount of data from impact.com, such as a detailed performance report, requesting all the data at once can lead to timeouts or API rate-limiting errors.
You can use the Jobs endpoint to schedule a job to extract data and fetch the results once complete. Jobs will protect you from hitting rate limits and will ensure a smoother data retrieval experience. This feature has been built into the ReportExport where a job is scheduled automatically for you when you use this endpoint.
Note: Read the best practices for exporting reports to learn more.
Job execution flow
The job execution time depends on the requested data and averages around 5 seconds. The job runs as follows:
- The job is
Scheduled. - The job is
Queuedto process. Jobs with large data set requests can wait in the queue and impact the execution time. - The job will
Run. - The job
Resultsbecome available for download.
| Endpoints | Description | |
|---|---|---|
| GET | /Agencies/{AccountSID}/Jobs/{JobId} | Retrieves the current details of a specific job (e.g., COMPLETED, ERROR, FAILED, or CANCELLED).
|
| GET | /Agencies/{AccountSID}/Jobs/{JobId}/Download | Downloads the results file for a job that has successfully completed. |
| PUT | /Agencies/{AccountSID}/Jobs/{JobId}/Replay | Re-runs a previously executed job. |
| GET | /Agencies/{AccountSID}/Jobs | Returns a list of jobs. |