Get export request by ID
Get the details of a specific export request by the corresponding exportId that was generated from the initiate export request endpoint.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
The x-site-context header is a JSON object that contains information about the source you wish to pull from. The mandatory account is the 24 character identifier found in Copilot. The channel (Sales channel ID), stage (environment name), and date attributes can be used to further narrow the scope of your data source.
Path Parameters
The exportId value that was generated from the initiate export request endpoint.
Response
The sample response of the create export request.
The unique ID for the export request that is used to retrieve the export details.
The start time of the export process.
The status of the export process. The download exported CSV file endpoint can generate a download URL only if the export status is COMPLETED.
IN_PROGRESS, COMPLETED, ERROR The type of data to export.
The end time of the export process.
The total number of exported data in the csv file. Each row in the csv file represents one record of exported data.
Errors during the export process. For more information about the error messages, see the exporting CSV section.
The S3 [fileId] to generate a downloadable CSV using the download exported CSV file endpoint.
Was this page helpful?