getProgramTotals( )

Retrieves the total amount of points earned, redeemed, and adjusted for the entire loyalty program.

The getProgramTotals() function returns a Promise that resolves to the combined total points for all loyalty accounts in the program.

The balance is the current total of points outstanding, while the earned, adjusted, and redeemed amounts are the all-time accumulated amounts. The totals include the amounts for all loyalty accounts.

Note: Only visitors with Manage Loyalty permissions can retrieve the loyalty program totals.

Admin Method

This function requires elevated permissions and runs only on the backend and on dashboard pages.

Permission Scopes

For app development, you must have one of the following permission scopes:
Read Loyalty
Manage Loyalty
Learn more about permission scopes.
Method Declaration
This method does not take any parameters
Return Type:Promise<GetProgramTotalsResponse>
Was this helpful?