FAfabric
Exports

Get all export requests

Get a paginated list of all the export requests.

get/api-offers/offers-exports

Request

Query parameters

sizeinteger

The maximum number of records per page.

offsetinteger

The number of records to skip before returning records. For example, with an offset of 20 and limit of 10, you will get records from 21 to 30.

sortstring
Example:+startedAt

Field to sort export requests.

type'REDEMPTION' | 'CALCULATED_PRICE'
Example:REDEMPTION

Type of data to export.

Headers

x-site-contextstring required
Example:{"date": "2023-01-01T00:00:00.000Z", "channel": 12, "account": "1234abcd5678efgh9ijklmno","stage":"production"}

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.

Response

OK

Example response

{
  "query": {
    "size": 10,
    "offset": 10,
    "count": 50
  },
  "data": [
    {
      "exportId": "ab50fe48-5da0-4e77-92d1-bb629eedf19e",
      "startedAt": "2023-05-17T21:24:52.398Z",
      "endedAt": "null",
      "status": "IN_PROGRESS",
      "type": "REDEMPTION",
      "fileId": "redemption/tenantId/1687294954996-redemption-export.csv"
    }
  ]
}

Changes

No recorded changes to this operation across all 2 revisions of this API.