Use this GET call to retrieve a customer's rewards summary. It returns overall totals and, when applicable, separate totals for labeled reward segments
GET /v2/customerProfile/getCustomerRewardSummaryRequest Headers
| Header | Required | Description |
|---|---|---|
X-CDLX-Session-Token | Yes | The session token obtained from the Get Session Token endpoint. The token identifies the customer through the encoded sourceCustomerId. |
This endpoint does not require a request body.
Response
| Property | Type | Description |
|---|---|---|
| requestId | string | Unique ID for the request. |
| rewardsSummary | RewardSummaryTotals | Totals across all of the customer's redemptions. |
| publisherLabelSummaries | map of label → RewardSummaryTotals | Totals for redemptions on offers carrying specific publisher labels configured for your institution. For label segmentation definitions, contact your Cardlytics representative. Returns when no labels apply. |
Example
Request
GET /v2/customerProfile/getCustomerRewardSummary
X-CDLX-Session-Token: <session-token>Response (when no publisher labels apply):
{
"requestId": "380052b4-3a64-4952-b640-ba696eb9f44b",
"rewardsSummary": {
"allTime": {
"redemptionCount": 35,
"redeemedOfferCount": 10,
"totalRedeemingTransactionAmount": 350.55,
"totalRewardAmount": 35.05
},
"yearToDate": {
"redemptionCount": 15,
"redeemedOfferCount": 5,
"totalRedeemingTransactionAmount": 150.55,
"totalRewardAmount": 15.05
},
"previousCalendarYear": {
"redemptionCount": 25,
"redeemedOfferCount": 10,
"totalRedeemingTransactionAmount": 250.80,
"totalRewardAmount": 25.08
},
"previousMonth": {
"redemptionCount": 7,
"redeemedOfferCount": 3,
"totalRedeemingTransactionAmount": 45.67,
"totalRewardAmount": 4.06
},
"previousTwelveMonths": {
"redemptionCount": 19,
"redeemedOfferCount": 9,
"totalRedeemingTransactionAmount": 200.34,
"totalRewardAmount": 20.03
},
"currentMonth": {
"redemptionCount": 5,
"redeemedOfferCount": 3,
"totalRedeemingTransactionAmount": 19.17,
"totalRewardAmount": 1.91
}
},
"publisherLabelSummaries": {}
}Response (when publisher labels apply):
{
"requestId": "380052b4-3a64-4952-b640-ba696eb9f44b",
"rewardsSummary": {
"allTime": {
"redemptionCount": 35,
"redeemedOfferCount": 10,
"totalRedeemingTransactionAmount": 350.55,
"totalRewardAmount": 35.05
},
"yearToDate": {
"redemptionCount": 15,
"redeemedOfferCount": 5,
"totalRedeemingTransactionAmount": 150.55,
"totalRewardAmount": 15.05
},
"previousCalendarYear": {
"redemptionCount": 25,
"redeemedOfferCount": 10,
"totalRedeemingTransactionAmount": 250.8,
"totalRewardAmount": 25.08
},
"previousMonth": {
"redemptionCount": 7,
"redeemedOfferCount": 3,
"totalRedeemingTransactionAmount": 45.67,
"totalRewardAmount": 4.06
},
"previousTwelveMonths": {
"redemptionCount": 19,
"redeemedOfferCount": 9,
"totalRedeemingTransactionAmount": 200.34,
"totalRewardAmount": 20.03
},
"currentMonth": {
"redemptionCount": 5,
"redeemedOfferCount": 3,
"totalRedeemingTransactionAmount": 19.17,
"totalRewardAmount": 1.91
}
},
"publisherLabelSummaries": {
"EXAMPLE_LABEL": {
"allTime": {
"redemptionCount": 12,
"redeemedOfferCount": 3,
"totalRedeemingTransactionAmount": 120.4,
"totalRewardAmount": 12.04
},
"yearToDate": {
"redemptionCount": 6,
"redeemedOfferCount": 2,
"totalRedeemingTransactionAmount": 60.2,
"totalRewardAmount": 6.02
},
"previousCalendarYear": {
"redemptionCount": 6,
"redeemedOfferCount": 3,
"totalRedeemingTransactionAmount": 60.2,
"totalRewardAmount": 6.02
},
"previousMonth": {
"redemptionCount": 2,
"redeemedOfferCount": 1,
"totalRedeemingTransactionAmount": 20,
"totalRewardAmount": 2
},
"previousTwelveMonths": {
"redemptionCount": 8,
"redeemedOfferCount": 3,
"totalRedeemingTransactionAmount": 80.3,
"totalRewardAmount": 8.03
},
"currentMonth": {
"redemptionCount": 2,
"redeemedOfferCount": 1,
"totalRedeemingTransactionAmount": 10,
"totalRewardAmount": 1
}
}
}
}