younifyd
Menu

Get Loyalty Statistics

Get loyalty program statistics

GET/v1/loyalty_programs/{loyaltyProgramId}/statistics

Use it in a workflow

  1. Add a step and choose the Talon.One connector.
  2. Pick the Get Loyalty Statistics action (under management).
  3. Fill in the fields below, then reference the result from later steps as {{getLoyaltyStatistics.response.data}}.

Request

Path parameters

loyaltyProgramIdinteger (int64)required

Identifier of the loyalty program. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint.

Response

Returns 200 with an object. Read it in later steps with {{getLoyaltyStatistics.response.data.<field>}}.

datestring (date-time)

Date at which data point was collected.

totalActivePointsnumber

Total of active points for this loyalty program.

totalPendingPointsnumber

Total of pending points for this loyalty program.

totalSpentPointsnumber

Total of spent points for this loyalty program.

totalExpiredPointsnumber

Total of expired points for this loyalty program.

totalNegativePointsnumber

Total of negative points for this loyalty program.

totalMembersnumber

Number of loyalty program members.

newMembersnumber

Number of members who joined on this day.

spentPointsobject
createdManuallynumberrequired
createdViaRuleEnginenumberrequired
earnedPointsobject
createdManuallynumberrequired
createdViaRuleEnginenumberrequired
json
{
  "date": "2025-01-01T00:00:00Z",
  "totalActivePoints": 9756,
  "totalPendingPoints": 548,
  "totalSpentPoints": 25668,
  "totalExpiredPoints": 1156,
  "totalNegativePoints": 32,
  "totalMembers": 2582,
  "newMembers": 3,
  "spentPoints": {
    "createdManually": 125,
    "createdViaRuleEngine": 9631
  },
  "earnedPoints": {
    "createdManually": 125,
    "createdViaRuleEngine": 9631
  }
}

Need more? See the Talon.One guide for connection setup and behaviour shared by every action.