Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/Rahat-Pagecode/gitbook-competitions/llms.txt

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

The Leaderboard feature turns your competitions into head-to-head contests by ranking customers against each other based on their instant win activity. Set per competition rather than globally, the Leaderboard integrates directly with your instant prizes to create a live podium that resets on your chosen schedule — or runs for the full duration of a competition.

​
Visual Modes

These modes offer a different visual to the standard table list, including themed layouts such as animated race stadium and jungle environments.
Visual modes are a great way to differentiate Leaderboard competitions and make them feel like a distinct event on your website, not just a list of ticket buyers.

​
Leaderboard Settings

The Leaderboard plugs in with instant wins to create a leaderboard podium. It can be intervalled by weekly or daily, as well as one leaderboard for the entire duration of a competition. Each Leaderboard is set per competition — it is not a global leaderboard. The leaderboard options can be found when setting up a new competition, located beneath the description box. You can set up any type of game mode as long as you have instant prizes enabled.

​
Game Modes

Counts how many times a customer has won an instant prize. Customers with the most instant wins are at the top of the leaderboard.
Add Pts or Points to your instant prize names (for example, “50 Points”) and the platform will tally up the points for each customer and rank them accordingly.
An exclusive game mode where customers compete to hold the Crown for the longest total time. You must put Crown and/or Steal in any instant win title — this allows someone to hold the Crown and start the timer.For example: “Steal it”, “Hold the Crown”, “Steal the Crown”Other keywords you can use instead of Crown or Steal: Throne, King, QueenFor example:
  • “Sit on the Throne”
  • “All Hail the new King”
  • “Long live with Queen”
The customer who holds the Crown for the greatest cumulative time wins.

​
Setting Up a Leaderboard

You can set the game mode, time the leaderboard resets and chooses a winner, and the interval. These settings are found when creating a new competition under the description box. For a leaderboard that lasts the entire duration of the competition and does not reset, tick the Set all time visuals option — this disables intervals and maintains an all-time leaderboard.
If you have the Payout feature enabled on your website, make sure to mark any instant prizes that do not carry a cash or physical reward as Non Payable. Otherwise, leaderboard points and game-mechanic wins will appear in your Payouts section as items awaiting fulfilment.

​
Tie Breakers

A customer who has held their score for longer is ranked higher than a customer who achieved the same score more recently. For example, a customer sitting on 8 points for a few hours will rank above someone who reached 8 points a few minutes ago.

​
How Do I Reward Winners?

You can manually reward winners, typically with wallet credit. For admins, you will be able to see the date ranges which you can click to see the timeline of the leaderboard at that point in time.

​
Automatic Wallet Credit

This also works with the Wallet Cash instant prize type if you have it enabled on your competition.
With this feature you can optionally run automatic wallet rewards. First, select Queue for approval mode on the Reward tab. After three competitions have been run on this mode, you will be able to unlock the Automatic mode. Set the wallet credit you want to reward for each position on interval resets. On the Payouts tab you will find a report of the current stats and a ledger of every reward paid. In Queue for approval mode, you will need to manually approve rewards before they are credited to winners’ accounts.
We advise you to check the ledger against your previous process to make sure it is accurate before approving winners. Three competitions need to be successfully approved to unlock the Automatic mode.
Automatic mode will skip the approval step and automatically reward winners roughly five minutes after the interval resets.
If you change the interval reset time to a different time on the same day, this will not cause a duplicate reward — the system checks per date, not per date and time.

Build docs developers (and LLMs) love

Get started for freeTalk to us