# Set Up a Leaderboard

Leaderboards rank your program participants alongside others to incentivize them to complete program objectives and encourage competition for the top ranks. You can add a leaderboard to your verified access widget or microsite and customize it like other components.

Leaderboards can be configured in a variety of ways to best suit the goals of your program. For more information on the different options, see [Leaderboards Explained](/brand/readme/advocate-program/manage-advocate-participant-experiences/leaderboards-explained.md).

{% hint style="warning" %}
This feature is only accessible to specific impact.com editions or add-ons. [Contact us](https://app.impact.com/support/portal.ihtml?createTicket=true&) to upgrade your account and get access!
{% endhint %}

{% stepper %}
{% step %}
**Step 1: Get leaderboards enabled**

Before you can begin setting up leaderboards, reach out to your Program Strategy Manager (PSM) or create a [support ticket](mailto:advocate-support@impact.com) to have the Leaderboards feature enabled for your program.
{% endstep %}

{% step %}
**Step 2: Add leaderboard to widget or microsite**

1. Navigate to your widget or microsite by selecting ![](/files/CDnwOBeIdds9r3Z6zTnO) **\[Engage] → Content → Edit widgets** or **Edit content**.
   * If you haven't set up a widget or microsite yet, you'll need to do so first.

     <div data-with-frame="true"><figure><img src="/files/tAkpZhkixA0IENA4Wzvz" alt=""><figcaption></figcaption></figure></div>
2. Select the widget or microsite page you want to edit.
   * Learn how to [edit widget content](/brand/readme/advocate-program/manage-advocate-participant-experiences/widget-experiences/customize-program-widgets.md) or [edit microsite pages](/brand/readme/advocate-program/manage-advocate-participant-experiences/microsite-experiences/customize-microsite-layouts-and-pages.md).
3. From the right sidebar menu, expand the **Leaderboard** component.
   * If you do not see the *Leaderboard* component, you'll first need to install a Mint Components package:
     * **Install Mint Components for widget**
       1. From the left sidebar menu, select **Packages → Add package**.
          1. On the *Mint Components* card, select **Add**.
          2. You should now be able to expand the **Leaderboard** component in the right sidebar menu.
     * **Install Mint Components for microsite**
       1. Return to the *Content* screen by selecting **→ \[Engage] Content** in your left navigation bar or your top menu.
       2. On the *Microsite* card, select **Edit settings**.
       3. Scroll until you see the *Packages* field, then select **Add package**.
       4. On the *Mint Components* card, select **Add**.
       5. Select **Save config** and return to the editor.
4. Select a type of **Leaderboard**.
   * For a description of each of the available leaderboards, refer to [Leaderboards Explained](/brand/readme/advocate-program/manage-advocate-participant-experiences/leaderboards-explained.md#leaderboard-types-0-0).
5. Select the blue **Add to** button on the canvas where you want the component to appear.

<figure><img src="/files/T6Nl9jP4vtcpeJLc1JiC" alt=""><figcaption></figcaption></figure>
{% endstep %}

{% step %}
**Step 3: Customize leaderboard**

{% tabs %}
{% tab title="Edit" %}

1. On your canvas, select the leaderboard component you want to edit.
2. Use the options in the **Edit** tab of the right sidebar menu to change the leaderboard properties.
   * If you want to insert a link into a text component, you can do so by selecting ![](/files/ZxWUjjyOFZd9hYxDvnMQ) **\[Code view]** and editing the widget or microsite’s HTML.
3. Select **Save Draft** when you're done.

**Edit fields reference**

| Setting                   | Description                                                                                                                                                                                                                       |
| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Unknown user text         | Enter the default display name for users without names, e.g., *Anonymous User*.                                                                                                                                                   |
| Hide viewing user         | Toggle on to make the viewing participant's row hidden if they don't fall among the top displayed ranks.                                                                                                                          |
| Leaderboard time interval | Enter a start and end date for which you want to view leaderboard results, in the form `mm/dd/yyyy`.                                                                                                                              |
| Leaderboard type          | Select the scoring system you want to use. For more information on the scoring systems available, see [Leaderboards Explained](/brand/readme/advocate-program/manage-advocate-participant-experiences/leaderboards-explained.md). |
| Maximum rows number       | Enter the maximum number of rows to be displayed on the leaderboard.                                                                                                                                                              |
| Program                   | Select a program to limit leaderboard results to participants in that program. To view results globally across all programs, don't select a program.                                                                              |
| Rank type                 | For more information on the types of ranking systems available, see [Leaderboards Explained](/brand/readme/advocate-program/manage-advocate-participant-experiences/leaderboards-explained.md).                                   |
| Rank column heading       | Enter the column name you want displayed for the *Rank* column.                                                                                                                                                                   |
| Show leaderboard rank     | ![](/files/OoA2qxPalfCYKZvmxuU6) **\[Toggle on]** if you want the leaderboard to display the *Rank* column.                                                                                                                       |
| Stats column heading      | Enter the column name you want displayed for the column containing participant scores.                                                                                                                                            |
| User column heading       | Enter the column name you want displayed for the column containing participant names.                                                                                                                                             |
| {% endtab %}              |                                                                                                                                                                                                                                   |

{% tab title="Move" %}

1. On your canvas, select the component you want to move.
2. Select ![](/files/1tCOApvKHkeA2OYCOWsc) **\[Move]**.
   * Some components can’t be moved. The ![](/files/1tCOApvKHkeA2OYCOWsc) **\[Move]** option will only appear if there’s another valid location on the canvas for the component to relocate to.
3. Select the blue **Move to** button where you want the component to go.
4. Select **Save**.
   {% endtab %}

{% tab title="Remove" %}

1. On your canvas, select the component you want to remove.
2. Select ![](/files/waifdRGeUhxtf0iBJNpV) **\[Remove]**.
3. Select **Save**.
   {% endtab %}
   {% endtabs %}
   {% endstep %}
   {% endstepper %}


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://help.impact.com/brand/readme/advocate-program/manage-advocate-participant-experiences/set-up-a-leaderboard.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
