# Creating Leaderboards

Adding a new leaderboard allows you to define the rules, timeframe, and visibility for how members will be ranked in your loyalty program. This process involves setting up basic information, choosing the duration, determining who can see it, and specifying the metric that will be tracked.

## Step-by-step instructions

Follow these steps to set up a new leaderboard in your Open Loyalty environment:

{% stepper %}
{% step %}
**Go to the Leaderboards section**

In the left-hand navigation, under **Loyalty Modules**, click on **Leaderboards**.

<figure><img src="https://2658975168-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FcNVX03KZzmrGwJihLiEx%2Fuploads%2FDg491oHpSkBfbsrNO1wz%2Fimage.png?alt=media&#x26;token=215c70ee-b116-4539-aacb-6e7235006879" alt=""><figcaption></figcaption></figure>
{% endstep %}

{% step %}
**Add a new leaderboard**

On the Leaderboards page, click the **Add leaderboard** button (located in the top right corner).

<figure><img src="https://2658975168-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FcNVX03KZzmrGwJihLiEx%2Fuploads%2Ffw7PQopofITIEMSIr3ZM%2Fimage.png?alt=media&#x26;token=025c3ede-d0aa-484e-bdc7-635200b82f28" alt=""><figcaption></figcaption></figure>
{% endstep %}

{% step %}
**Basic Info**

* **Title and description:** Enter a clear Leaderboard name (e.g., "Top Spenders," "Most Active Members") and an optional Leaderboard description to explain its purpose.

<figure><img src="https://2658975168-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FcNVX03KZzmrGwJihLiEx%2Fuploads%2F0q2Gl9KwDjG9IWY3I9k7%2Fimage.png?alt=media&#x26;token=791efa0d-f682-4125-84e0-7919e69fe385" alt=""><figcaption></figcaption></figure>
{% endstep %}

{% step %}
**Timeframe**

* **Start date:** Select the date when the leaderboard should begin tracking member activity.&#x20;
* **End date (optional):** Choose an end date if you want the leaderboard to stop tracking activity after a specific period.

{% hint style="danger" %}
Leaderboards will not do a retroactive calculation, even if you set a date in the past!
{% endhint %}

<figure><img src="https://2658975168-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FcNVX03KZzmrGwJihLiEx%2Fuploads%2FypnxJUrPnKDDhWes8x6W%2Fimage.png?alt=media&#x26;token=4ca35b22-32b1-480e-bed4-4f6c19778d3f" alt=""><figcaption></figcaption></figure>
{% endstep %}

{% step %}
**Visibility**

From the **Leaderboard visibility** dropdown, select who can see the leaderboard:

* **Visible for everyone:** The leaderboard will be visible to all members.
* **Tiers Visibility:** The leaderboard will be visible only to members in specific tiers that you choose.
* **Segment Visibility:** The leaderboard will be visible only to the specific segments that you choose.
* **Hidden:** The leaderboard remains hidden from all members.

<figure><img src="https://2658975168-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FcNVX03KZzmrGwJihLiEx%2Fuploads%2FJWf0WoRWroqGncCkwJXp%2Fimage.png?alt=media&#x26;token=c20c7a2d-7880-4ee4-8617-d5946f3a6cd9" alt=""><figcaption></figcaption></figure>
{% endstep %}

{% step %}
**Custom Attributes**

This section allows you to include custom data fields for additional details. For now, you can leave this as default unless you have specific custom attributes to add.

<figure><img src="https://2658975168-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FcNVX03KZzmrGwJihLiEx%2Fuploads%2FuKtPT6PdeO3rwtklJw06%2Fimage.png?alt=media&#x26;token=333470f7-184c-4850-ad69-c6b953b27b50" alt=""><figcaption></figcaption></figure>
{% endstep %}

{% step %}
**Tracked Metric**

* Select the type of activity you want to measure and rank members by from the Metric dropdown (e.g., "Cumulative earned units in a wallet").
* If applicable, select the Wallet type.

<figure><img src="https://2658975168-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FcNVX03KZzmrGwJihLiEx%2Fuploads%2FHEsbqBlRm6eKsW3geQfK%2Fimage.png?alt=media&#x26;token=751ab458-8d9e-4676-a384-7573eb2e5158" alt=""><figcaption></figcaption></figure>
{% endstep %}

{% step %}
**Status**

Toggle the Active switch to enable or disable the leaderboard. An active leaderboard will collect data.

<figure><img src="https://2658975168-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FcNVX03KZzmrGwJihLiEx%2Fuploads%2FzIVtlBgBlKuacxmDWsMO%2Fimage.png?alt=media&#x26;token=e0ea773c-8909-44e3-a8f9-89509c691c78" alt=""><figcaption></figcaption></figure>
{% endstep %}

{% step %}
**Rewarding Cycle (optional)**

You can enable the rewarding cycle for top ranking members.

<figure><img src="https://2658975168-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FcNVX03KZzmrGwJihLiEx%2Fuploads%2Fd88Sty39xX68xjENtOvk%2Fimage.png?alt=media&#x26;token=c40cbb2b-a5c3-4040-a40a-ec04db172693" alt=""><figcaption></figcaption></figure>

{% hint style="info" %}
For more information on the rewarding cycle, please refer to this section of the User Guide: [rewarding-cycle](https://help.openloyalty.io/main-features/leaderboards/rewarding-cycle "mention")
{% endhint %}
{% endstep %}

{% step %}
**Summary**

Review all your settings. If everything looks correct, click **Add leaderboard**.
{% endstep %}
{% endstepper %}

## Final tips

* **Currently, you can have up to 3 active leaderboards within an environment.**
* Members with the same tracked metric value will tie and appear in the same position on the leaderboard.
* Leaderboards are recalculated **every 4 hours.**
* Future updates will expand leaderboard capabilities, including the ability to target specific segments or tiers and introduce additional conditions.