API reference
API reference
Select your platform
No SDKs available
No versions available

LeaderboardUpdateStatus

Updated: Oct 30, 2025

LeaderboardUpdateStatus

interface LeaderboardUpdateStatus
This object is a response from the server that contains information about the status of the request to update the leaderboard. It can be retrieved using two different API requests: horizon.platform.leaderboards.Leaderboards.writeEntry and horizon.platform.leaderboards.Leaderboards.writeEntryWithSupplementaryMetric.

Properties

NameSummary
didUpdate
abstract val didUpdate: Boolean
A boolean indicates whether the leaderboard was updated.
json
open val json: String
updatedChallengeIds
abstract val updatedChallengeIds: List<String>?
If the leaderboard is updated, this represents the updated challenge IDs. The updated challenge IDs can be used by horizon.platform.challenges.Challenges.getEntries, horizon.platform.challenges.Challenges.getEntriesAfterRank, or horizon.platform.challenges.Challenges.getEntriesByIds APIs.