POST
/
api-offers
/
offers-exports

Authorizations

​
Authorization
string
headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
x-site-context
string
required

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.

Body

application/json

The sample request to initiate data export.

​
type
enum<string>
required

The type of data to export.

Available options:
REDEMPTION,
CALCULATED_PRICE
​
filters
object[]

Filters to apply when exporting the data. You can include multiple filter values in the request. If you do not include any filters, 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

200 - application/json

The sample response of the create export request.

​
exportId
string
required

The unique ID for the export request that is used to retrieve the export details.

​
startedAt
string
required

The start time of the export process.

​
status
enum<string>
required

The status of the export process. The download exported CSV file endpoint can generate a download URL only if the export status is COMPLETED.

Available options:
IN_PROGRESS,
COMPLETED,
ERROR
​
type
string
required

The type of data to export.

​
endedAt
string | null

The end time of the export process.

​
totalDataExported
number

The total number of exported data in the csv file. Each row in the csv file represents one record of exported data.

​
errors
object[]

Errors during the export process. For more information about the error messages, see the exporting CSV section.

​
filters
object[]

Was this page helpful?

Get export request by IDGet all export requests