GET
/
offers-exports
/
{exportId}

Authorizations

Authorization
string
headerrequired

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

Headers

x-fabric-tenant-id
string
required

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.

Required string length: 24
x-fabric-channel-id
string

The sales channel ID.

x-client-id
string

A unique identifier obtained from Copilot for the System app in the fabric ecosystem, essential for OpenID Connect authentication flows.

x-fabric-request-id
string

A unique request ID.

Path Parameters

exportId
string
required

The exportId value that was generated from the initiate export request endpoint.

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
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. The following are possible statuses:

  • 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[]
fileId
string

The S3 fileId value to generate a downloadable CSV using the download exported CSV file endpoint.