Documentation

Support

Leaderboard archives and versions

Understand how you can create read-only archived versions when you reset scores.
Read time 1 minuteLast updated 3 months ago

Archives

When resetting a leaderboard manually or using a scheduled reset, you can optionally create a read-only archive copy of the current leaderboard scores, which game clients can access by fetching scores for that archived version. Refer to the Leaderboards resets page for details on resets.

Archive limits

  • Each leaderboard can have 10,000 archived versions.
  • On exceeding the archive limit the oldest leaderboard archives are deleted on a first-in, first-out (FIFO) basis.
Warning
When using leaderboard archives be mindful of your data retention policy and that each archived version leaderboards will count towards the number of leaderboards used per Monthly Active User.

Versions

Every leaderboard maintains a versionId to identify its current live version. It also maintains an array of versions for previous archived resets.
  • Initial version: A
    versionId
    is generated automatically when you first create a leaderboard.
  • Version on reset: Each time a leaderboard is reset (manually or via a scheduled reset), the existing live version is archived under its current
    versionId
    , and the system generates a new
    versionId
    for the newly live leaderboard.
  • Live vs. archived:
    • Live version: Only the most recent version of a leaderboard (the live version) accepts new score submissions.
    • Archived versions: All previous versions (created during resets) become read-only archives that you can query for historical data.
  • Version identifiers:
    versionId
    is system-generated and cannot be customized. A valid
    versionId
    is a 23-character numeric string, for example:
    20250407151515238177311
    .
Note
The versionId parameter in
AddPlayerScore
requests serves as a safeguard: it can be used to ensure that outdated game clients cannot inadvertently submit scores to a newer live leaderboard. You can only submit scores to the live leaderboard version.