Leaderboard
Encourage customer engagement by displaying a gamified leaderboard on your website or mobile app. Use the Leaderboard API to showcase top-performing customers and motivate further interaction.
Available APIs
GET - Customers Leaderboard
This API call is used to retrieve customers' leaderboard within a date range or for all time, ordered from the highest to the lowest rank.
Security: Requires apikey and secretkey headers.
Request
Query Parameters
from datetime
Optional
The start date of the leaderboard range. If not provided, the leaderboard shows all-time data.
to datetime
Optional
The end date of the leaderboard range. If not provided, the leaderboard shows all-time data.
customerId string
Optional
Unique identifier for the customer that you can reference across the customer’s whole lifetime. It is used to get the rank of this customer in the leaderboard.
rewardCampaignId integer
Optional
Filter leaderboard results based on a specific reward campaign.
customerTag string
Optional
Filter results by customers who are tagged with a specific tag.
rewardCampaignTag string
Optional
Filter leaderboard results by reward campaign tags.
Response
application/json
leaderboard array
An array of customers ranked on the leaderboard, sorted by their score. Each entry in the array includes details about each customer, providing a comprehensive overview of their standing within the entire customer base.
customerRank number
The position of the requested customer on the leaderboard, reflecting their rank relative to all other customers in your entire customer base. A lower rank number (e.g., 1) indicates a higher standing, typically based on points or achievements.
customersCount number
The total number of customers on the leaderboard.
Sample Response
Last updated