What is a Leaderboard Report?
The Leaderboard report allows you to rank people, activities, or activity types by score, usage, or any custom measure. For instance, use a Leaderboard report to show a list of your most active users or most viewed pieces of content. This report type is good for exporting tables into a spreadsheet because it shows text-based data.
Creating and Editing a Leaderboard Report
Use the report builder to create new Leaderboard reports and to configure existing Leaderboard reports.
Leaderboard Report Filters and Options
Beyond the typical report builder filters and options, the Leaderboard report provides options that are unique to the Leaderboard report.
Leaderboard Filter
Select Leaderboard from the report selection menu and then click Leaderboard in the filter menu:
In the Leaderboard filter, you’ll choose what you’d like to rank (using the Organized menu) and how you’d like to rank it (using the Measures menu).
Organized Menu
On the Organized menu, you’ll choose what you’d like to rank on the Leaderboard. Choose an option from the Organized menu and the Leaderboard will organize data by what you’ve chosen.
Measures Menu
On the Measures menu, you’ll choose how you’d like to rank what you chose in the Organized menu. You can choose multiple measures for the same Leaderboard, but we don’t recommending choosing more than 4 because of the size of the Leaderboards.
Related: What are Measures?
To add a measure to the Leaderboard, choose a measure from the Select a Measure menu and click the Add Measure button next to the menu. You’ll see the measure added to the Leaderboard, and the measure will be added to the Measures section. You can add as many measures as you need to a leaderboard. To deselect a measure, click the X next to the Measure in the Measures section:
Default Sort
The default sort menu determines the order rows will be sorted by default. Sorting Ascending means that lower numbers or letters near the start of the alphabet will be listed first. Sorting Descending means that higher numbers or letters nearer the end of the alphabet will be listed first.
Top Results
Sometimes you may only want a leaderboard to only display the top results. The Top Results dropdown allows you to restrict a Leaderboard to display only the top 5, 10, 15, 20, 20, 50 or 100 rows along with its ranking:
Advanced Configuration
Advanced configuration is designed to be used by expert users who understand JSON and the properties of xAPI statements.
Certain settings (like custom text) are unique to the Leaderboard report and only configurable in Advanced Configuration.
Property |
Explanation |
Example value |
showSentence |
If it's included with a value of |
false |
hideDimension |
If it's included with a value of |
true |
hidePII |
If it's included with a value of |
true |
cardText |
Defines the text that appears on the dashboard, and any preview of the report. |
See below |
detailView |
Defines the text that appears on the leaderboard (see below). |
See below |
The report text property on leaderboards takes this structure:
"cardText": { "cardView": { "dimension": "{{dimension}}" }, "detailView": { "dimension": "{{dimension}}", "sentence": "{{activityCount}} distinct {{activityName}} for {{peopleCount}} distinct {{peopleName}} {{observedVerb}} over {{dimensionCount}} distinct {{dimension}}." } }
The cardView
object controls what text is displayed when the leaderboard is viewed as a report on the dashboard. The detailView
object controls what text is displayed when the full report detail is viewed. {{placeholders}}
are used to fill in variable values.
The table below explains the allowed properties of these objects.
Property |
Explanation |
dimension |
The header of the first column of the leaderboard. By default this is the name of the dimension. Only supports the dimension placeholder. |
sentence |
The text of the sentence displayed at the top of the leaderboard. This sentence will only appear if the report’s |
The table below explains the allowed placeholders.
Placeholder |
Explanation |
activityCount |
The number of activities in the filtered result set. |
peopleCount |
The number of people in the filtered result set. |
dimensionCount |
The number of dimension items in the filtered result set, for example if the report is organized by weeks, this would be the number of weeks. |
activityName |
Either “activity” if activityCount is 1 or “activities” otherwise. |
peopleName |
Either “person” if peopleCount is 1 or “people” otherwise. |
observedVerb |
Either “was observed” if peopleCount is 1 or “were observed” otherwise. |
dimension |
The name of the dimension. |
Related: Check out our Advanced Configuration guide for more information on customizing your reports.