Manage leaderboards from the Admin Portal

Last updated on October 24, 2024

Overview

This article guides you through managing leaderboards in your game from the AccelByte Gaming Services (AGS) Admin Portal, including how to:

• View leaderboard details and players
• Update leaderboard details, cycles, and all-time setting
• Reset leaderboards
• Hide players from leaderboards
• Delete players from leaderboards

Prerequisite

• Access to the AGS Admin Portal.

View leaderboards

1. In the AGS Admin Portal, go to the game namespace with the leaderboard you want to view.

2. On the sidebar menu, go to Engagement > Leaderboard. The Leaderboard page appears displaying a list of leaderboards in the game.

3. From the list of leaderboards, find the leaderboard you want to view and click on its code to open its details page. Use the Cycles dropdown to filter the list by specific cycles.

4. On the details page of the leaderboard, you can view the following:

   • Leaderboard details: shows the leaderboard's code, name, statcode (statistic code), cycles, order.
   • Leaderboard data
     • All Players: shows all the players in the leaderboard.
     • Hidden Players: lists players who are part of the leaderboard but are hidden from view in-game.

Update leaderboard details, cycles, and all-time setting

1. Go to the details page of the leaderboard you want to update.
2. In the Leaderboard Details section, you can update the leaderboard as follows:
   • Update the leaderboard name.
   • Add or remove cycles from the leaderboard.
   • Enable or disable the All-time cycle setting of the leaderboard.
     • If enabled, the leaderboard updates regularly to show rankings from the entire history of the game.
     • If disabled, the leaderboard displays rankings for a specific period or cycle.
   • Change how the leaderboard displays the order of the ranked players, either by ascending or descending order.
   • Upload or change the icon of the leaderboard.

Reset leaderboard cycles

Resetting a leaderboard cycle resets all ranking data or the points of all players in it. After resetting a leaderboard cycle is reset, it'll be filled again with data when its statistical code configuration is updated.

To reset a leaderboard, follow these steps:

1. Go to the details page of the leaderboard you want to reset.
2. On the Leaderboard Detail page, click on the Reset Leaderboard button in the Leaderboard Data section. The Reset Leaderboard modal will appear and you are required to select the cycle you want to reset.
3. On the confirmation message, select which cycle of the leaderboard you want to reset and then click Reset. The leaderboard cycle is immediately reset.

Hide players from leaderboards

1. Go to the details page of the leaderboard.
2. On the details page of the leaderboard, select the leaderboard cycle on where the user ranking you want to delete.
3. Under the All Players tab in the Leaderboard Data section, find the player that you want to delete, click on the Action (...) menu and select Delete.
4. Click on Hide on the confirmation message. The player is immediately hidden from the leaderboard. To view hidden players, go to the Hidden Players tab.

Delete player ranking data

Deleting a player's ranking data immediately removes them from the leaderboard they're in. They can still rejoin the leaderboard if they manage to gain enough ranking points during the leaderboard cycle.

info

To prevent players from rejoining leaderboards after deleting their ranking data, you can ban them from logging into your game or from matchmaking pools.

To delete a player's ranking data in a leaderboard, follow these steps:

1. Go to the details page of the leaderboard.
2. On the details page of the leaderboard, select the leaderboard cycle on where the user ranking you want to delete.
3. Under the All Players tab in the Leaderboard Data section, find the player that you want to delete, click on the Action (...) menu and select Delete.
4. Click on Delete on the confirmation message. The player is immediately deleted from the leaderboard cycle.