Documentation Index

Fetch the complete documentation index at: https://docs.xtremepush.com/llms.txt

Use this file to discover all available pages before exploring further.

Use Case: Monthly Rewards Leaderboard

Prev Next

You want a global leaderboard for VIP users at Level 3 and above, ranking them by their total rewards won. You want the leaderboard to run indefinitely, with rewards given out every 4 weeks. The configuration for this example is as follows:

Leaderboard Score

Here, you configure the leaderboard score to rank users by their total rewards won.

  • Progress Counter: Set to User Attribute value.

  • Score User Attribute: Set to reward.primaryReward, which is the Xtremepush loyalty attribute for total rewards earned.

  • Start At and End At: Leave both empty, since this leaderboard runs indefinitely.

Configuration settings for leaderboard score, including user attributes and date range.

Tiering

Leave this section empty, since you don't need to split this leaderboard into separate leaderboards for this use case.

Participation

This leaderboard is only for VIP users who are Level 3 and above. You also want to give users the option to opt in to the leaderboard rather than being entered automatically.

  • Add a requirement that Level ≥ 3.

  • Add a requirement that VIP is equal to Yes.

  • Select Require users to opt in before they can score, so users choose to join the leaderboard rather than being entered automatically.

Settings for leaderboard participation criteria including level and VIP status requirements.

Rewards

Set the Rotation Period to 4 weeks, so rewards are given out every 4 weeks. Since the score is based on a user attribute, a user's position doesn't reset between rotations. See Rewards in Configure Leaderboards for more information.

Set the reward configuration is as follows:

From position

To position

Reward

1

1

1000 tokens

2

5

500 tokens

11

20

250 tokens

21

49

Weekly Wager Challenge quest and Big Spender Streak quest

Presentation

Configure how this leaderboard appears to users in the widget, including messaging for users who aren't yet eligible to take part.

  • Title: Top Reward Earners

  • Description: Compete to top the leaderboard by winning the most in total rewards. The leaderboard refreshes every 4 weeks, so there's a fresh chance to place every cycle.

  • Blocked description: You need to be a VIP player at Level 3 or above to join this leaderboard.

  • Score label: Total Rewards Won