Customer Leaderboard
Retrieve leaderboard rankings of customers within your loyalty program in Gameball, either for a specific date range or for all time.
GET
cURL
Customer Leaderboard
This API retrieves the leaderboard rankings of customers within your loyalty program in Gameball, either for a specific date range or for all time. Results are ordered from the highest to the lowest rank, displaying each customer’s rank, progress, and tier details.The Leaderboard API is part of the Advanced leaderboard. It needs the Advanced leaderboard plan feature, on your plan or as an add-on, and an active subscription. The Normal leaderboard does not include it.
- Each request returns up to 50 rows.
- Use
fromandtofor custom date ranges. The range must start within the last 62 days. - Filter by
customerTag,rewardCampaignId, orrewardCampaignTag. - The leaderboard ranks 1,000 customers by default, up to 10,000.
Security: Requires apikey header.
Query Parameters
Response
200 - application/json
Leaderboard retrieved successfully