This guide explains the workflow for using the ReportExport and ClickExport endpoints and how to make the best use of Replay, the report caching feature.
ReportExport and ClickExport allow you to schedule a report to be generated in the background. This is an asynchronous process, meaning that the API doesn’t return the report file immediately.
How to get your report
- Request the report by making a GET call to ReportExport or ClickExport with all your required report parameters, like dates and filters. The API will respond with job details, including a job ID and a download URI.
- Periodically check the job status by checking the Jobs endpoint using the job ID. Wait for the job Status to change from
QUEUEDorRUNNINGtoCOMPLETED. Alternatively, make use of a postback (webhook) notification, which will alert you when the job status changes toCOMPLETED. - Download the report file once the status is
COMPLETED, using the download URI provided in the initial response.
Cache reports with Replay
If you make a request to ReportExport or ClickExport with the exact same parameters as a previous request, a new report will not be generated. Instead, the impact.com API will recognize the duplicate request and return the job details for the already existing report.