2 Download API

This API helps to generate a pre-authenticated URL (PAR URL), to download the report in CSV format, if the number of records in a report is more than 5000.

The status response can contain the following values:

  • COMPLETED - When the export API execution is completed successfully and response is generated for
    • Number of records below 5000
    • Number of records above 5000
  • PENDING - denotes that the report export is yet to start and is in the queue.
  • RUNNING - When the API execution is in progress.
  • FAILED - When the Export API execution is not completed successfully.