Initiate export request
Initiate an export request based on the specified filter criteria.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
A header used by fabric to identify the tenant making the request. You must include tenant id in the authentication header for an API request to access any of fabric’s endpoints. You can retrieve the tenant id , which is also called account id, from Copilot. This header is required.
24The sales channel ID.
A unique identifier obtained from Copilot for the System app in the fabric ecosystem, essential for OpenID Connect authentication flows.
A unique request ID.
Body
The sample request to initiate data export.
The type of data to export.
REDEMPTION, CALCULATED_PRICE Filters to apply when exporting the data. You can include multiple filter values in the request. If you do not include any filters parameter, all export data of the specified data type is returned. For more information on using filters to refine your data, see the export parameters section.
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. The following are possible statuses:
IN_PROGRESSCOMPLETEDERROR
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.
Was this page helpful?