> For the complete documentation index, see [llms.txt](https://docs.gmetri.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.gmetri.com/metaverse/analytics/leaderboard.md).

# Leaderboard

Leaderboard helps to track the scores of your viewers in the form of a table.

<figure><img src="/files/y3cynYJeFYI3KTiE4TPj" alt=""><figcaption><p>Leaderboard</p></figcaption></figure>

You can expand this section to a new page, with more details, by clicking on the **more** button. This page is pre-authenticated and the URL can be shared publicly.

### Full Page Leaderboard

{% hint style="info" %}
This page auto-refreshes periodically
{% endhint %}

Below is the screenshot of a full-page leaderboard.

<figure><img src="/files/afbBlNmg1l7XUwiTAP60" alt=""><figcaption><p>Leaderboard - More page</p></figcaption></figure>

The login name will appear on the leaderboard under "Name" if the authentication is set to "Social" or "Viewer Group" while publishing a deployment.

The number of times a scene from your experience has been viewed by a customer is indicated on this page.

### **Optional Parameters**

The following parameters can be optionally passed in the leader board URL:

<table><thead><tr><th width="267">Parameter</th><th>Default Values</th><th width="301">Function</th><th>Table Header</th></tr></thead><tbody><tr><td><code>rows=&#x3C;num></code></td><td>50</td><td>Controls the number of rows shown in the leaderboard.</td><td>-</td></tr><tr><td><code>show_rank=true|false</code></td><td>true</td><td>Controls if the viewer rank is shown in leader board.</td><td>Rank</td></tr><tr><td><code>show_identifier=true|false</code></td><td>false</td><td>Controls if the viewer identifier is shown in the leaderboard.</td><td>Identifier</td></tr><tr><td><code>show_name=true|false</code></td><td>true</td><td>Controls if the viewer name is shown in the leaderboard.</td><td>name</td></tr><tr><td><code>show_variables=&#x3C;header1|var_name_1>, &#x3C;header2|var_name_2>....</code></td><td>-</td><td>Exposes any custom user variables. Here, <code>header</code> is any placeholder for the variable. The variable name to be shown is provided after the pipe <code>|</code>.</td><td>As provided within the parameter (<code>header1</code>, <code>header2</code> etc.)</td></tr><tr><td><code>show_score=true|false</code></td><td>true</td><td>Controls if the viewer score is shown in leader board.</td><td>Score</td></tr><tr><td><code>keep= variable1_name| include_value_1: include_value_2: include_value_3, variable2_name| include_value_1: include_value_2: include_value_3</code></td><td>-</td><td>1662a44cfb954c07b93a7f22e38d56ae-43500abcd34f4abdb4ee9a483c5e18a0</td><td></td></tr></tbody></table>

\| <p><br>Use a variable to filter the leaderboard. A variable associated with the viewer is used as a table filter. `keep` will keep entries in leaderboard for only the specified variable values. One can allow inclusion of multiple variable values as well as filter using multiple variable. Variable values are separated by a colon ':', variables are separated by a ',' and variable are separated from their values by '|'.</p> |
\| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## 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://docs.gmetri.com/metaverse/analytics/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.