Skip to main content
Version: 5.7.0

Leaderboard

API Summary​

Leaderboard​

  • DeleteLeaderboards - Delete leaderboards.
  • CreateLeaderboard - Create a leaderboard. Optional parameter,data, numDaysToRotate(but mandatory for 'DAYS' rotationType.
  • EditLeaderboard - Edit a leaderboard. Optional parameter,data, numDaysToRotate(but mandatory for 'DAYS' rotationType.
  • ListAllLeaderboards - List all the leaderboards.
  • GetGlobalLeaderboardPage - Retrieve a page of the global leaderboard specified by the start and end indexes (0-based).
  • GetGlobalLeaderboardVersions - Retrieve information about the retained versions for the leaderboard (sorted newest to oldest).
  • GetGlobalLeaderboardEntryCount - Gets the number of entries in a global leaderboard.
  • PostScoreToLeaderboardOnBehalfOf - Post score to another player's score.
  • SysCreateLeaderboard - Create a new player or group entry leaderboard configuration.
  • SysEditLeaderboard - Edit a player or group entry leaderboard configuration.
  • SysResetNeverLeaderboard - Resets a leaderboard configured with rotation strategy NEVER by incrementing its version.
  • SysCreateLeaderboardConfig - Creates a leaderboard configuration, with support for tournament leaderboards.
  • SysEditLeaderboardConfig - Edits a leaderboard configuration, with support for tournament leaderboards.
  • SysGetLeaderboardConfig - Returns leaderboard configuration information, including tournament settings, for future and current (active) version of the specified leaderboard.
  • SysListLeaderboardConfigs - Returns list of applicable leaderboards, with summary leaderboard configuration information, including tournament flags, if applicable. Option 'filterType' defaults to 'standard', with additional supported filter types of 'all', 'tournament', 'divisions' and 'templates'.
  • SysEditTournamentSettingsForFuturePeriodsOnly - Updates the tournament settings for the leaderboard configuration, for future recurring periods only (does not affect current rotation). Supported tSettingsJson settings include: 'tTournament' (with 'tConfigs' to configure tournament templates, 'tAutoJoin' flag, 'tAutoClaim' flag), and 'tPhases' (to schedule 'enrolMins', 'announcementMins', 'disallowMins' and 'bufferMins' minutes).
  • SysEditTournamentSettingsIncludingCurrentPeriod - Updates the tournament settings for the leaderboard configuration, for the current period in progress, as well as the future periods if recurring periods (not ADHOC). Supported tSettingsJson settings include: 'tTournament' (with 'tConfigs' to configure tournament templates, 'tAutoJoin' flag, 'tAutoClaim' flag), and 'tPhases' (to schedule 'enrolMins', 'announcementMins', 'disallowMins' and 'bufferMins' minutes), and, if ADHOC tournament in progress, API also supports 'tPeriod' duration settings ('durationDays', 'durationDays', 'durationDays').
  • SysCreateAdhocTournamentPeriod - Schedules a new tournament period for the ADHOC leaderboard configuration. Tournament must be scheduled in the future. Tournament settings ('tSettingsJson') must include tournament period ('tPeriod'), tournament configs and associated flags ('tTournament') and tournament phases ('tPhases').
  • SysEditAdhocTournamentPeriod - Updates a future ADHOC tournament period scheduled for the leaderboard configuration, identified by the existing period's UTC startingAt time, in milliseconds. Period being edited must be scheduled in the future, not in-progress. Tournament settings may include tournament period ('tPeriod'), tournament configs and associated flags ('tTournament') and tournament phases ('tPhases').
  • SysDeleteAdhocTournamentPeriod - Deletes a future ADHOC tournament period scheduled for the leaderboard configuration, identified by the existing period's UTC startingAt time, in milliseconds. Period being edited must be scheduled in the future, not in-progress. Tournament settings may include tournament period ('tPeriod'), tournament configs and associated flags ('tTournament') and tournament phases ('tPhases').
  • SysGetLeaderboardConfigsPage - Returns a page of leaderboard configurations from the server based on the specified context.
  • SysGetLeaderboardConfigsPageOffset - Gets the page of leaderboard configuration information from the server based on the encoded context and specified page offset.
tip

All the client APIs that the names beigin with "Sys" are also available to S2S. For the usages of the S2S leaderboard APIs (if they are not listed at this section below), refer to brainCloud client leaderboard APIs.

Last updated on by Jason Liang