POST
/
api-offers
/
offers-exports
/
actions
/
download-export-file
curl --request POST \
  --url https://live.copilot.fabric.inc/api-offers/offers-exports/actions/download-export-file \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-site-context: <x-site-context>' \
  --data '{
  "fileId": "redemption/tenantId/1687472972-redemption-export.csv"
}'
{
  "url": "https://bucket-name.s3.amazonaws.com/redemption/tenantId/1687472972-redemption-export.csv?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=ASIA26KLJWUAPER5A",
  "fileId": "redemption/tenantId/1687472972-redemption-export.csv"
}

Authorizations

​
Authorization
string
header
required

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.

Example:

"{\"date\": \"2023-01-01T00:00:00.000Z\", \"channel\": 12, \"account\": \"1234abcd5678efgh9ijklmno\",\"stage\":\"production\"}"

Body

application/json

The URL of the downloadable CSV.

​
fileId
string
required

The fileId value retrieved from the get export request by ID endpoint. This is used to download the exported CSV.

Example:

"redemption/tenantId/1687472972-redemption-export.csv"

Response

200
application/json
OK

The URL of the downloadable CSV.

​
url
string
required

The AWS S3 URL to download the exported CSV.

Example:

"https://bucket-name.s3.amazonaws.com/redemption/tenantId/1687472972-redemption-export.csv?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=ASIA26KLJWUAPER5A"

​
fileId
string
required

The S3 fileId value to generate a downloadable CSV.

Example:

"redemption/tenantId/1687472972-redemption-export.csv"

Was this page helpful?