Export customer loyalty balances
GET {{baseUrl}}/v1/loyalty_programs/:loyaltyProgramId/export_customer_balances?endDate=2022-11-08T00:11:22.082Z
Download a CSV file containing the balance of each customer in the loyalty program.
Tip: If the exported CSV file is too large to view, you can split it into multiple files.
The generated file can contain the following columns:
loyaltyProgramID: The ID of the loyalty program.loyaltySubledger: The name of the subdleger, when applicatble.profileIntegrationID: The integration ID of the customer profile.currentBalance: The current point balance.pendingBalance: The number of pending points.expiredBalance: The number of expired points.spentBalance: The number of spent points.currentTier: The tier that the customer is in at the time of the export.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
endDate | string | Used to return balances only for entries older than this timestamp. The expired, active, and pending points are relative to this timestamp. |
Note: It must be an RFC3339 timestamp string. |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |