Get export request by ID

Get details of a specific export request by its ID.

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.

Path Parameters

exportId

string

required

Export ID

Response

200 - application/json

The sample response of the create export request.

exportId

string

required

A unique ID for the export request.

startedAt

string

required

The start time of the export process.

status

enum<string>

required

The status of the export process.

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 export process.

Show child attributes

filters

object[]

Show child attributes

fileId

string

The S3 file ID to generate a downloadable file.