TAtalon
Loyalty

Get loyalty program statistics

[!note] Management API endpoints are not meant to be used in real-time integrations that directly serve your end users. Rate limit: 3 requests per second.

[!warning] This endpoint is deprecated.

To retrieve statistics for a loyalty program, use the Get statistics for loyalty dashboard endpoint.

Retrieve the statistics of the specified loyalty program, such as the total active points, pending points, spent points, and expired points.

get/v1/loyalty_programs/{loyaltyProgramId}/statistics

Request

Path parameters

loyaltyProgramIdinteger required

Identifier of the loyalty program. You can get the ID with the List loyalty programs endpoint.

Response

OK

datestring date-time required

Date at which data point was collected.

totalActivePointsnumber required

Total of active points for this loyalty program.

totalPendingPointsnumber required

Total of pending points for this loyalty program.

totalSpentPointsnumber required

Total of spent points for this loyalty program.

totalExpiredPointsnumber required

Total of expired points for this loyalty program.

totalNegativePointsnumber required

Total of negative points for this loyalty program.

totalMembersnumber required

Number of loyalty program members.

newMembersnumber required

Number of members who joined on this day.

Example response

{
  "totalActivePoints": 9756,
  "totalPendingPoints": 548,
  "totalSpentPoints": 25668,
  "totalExpiredPoints": 1156,
  "totalNegativePoints": 32,
  "totalMembers": 2582,
  "newMembers": 3,
  "spentPoints": {
    "createdManually": 125,
    "createdViaRuleEngine": 9631
  },
  "earnedPoints": {
    "createdManually": 125,
    "createdViaRuleEngine": 9631
  }
}

Changes

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