entity_rank_on_leaderboard_version_ended - XBOX Game Development Documentation

This event is triggered when a leaderboard version is reset to a new version for a game title, containing the entity’s rank and score data from the ended version.

Properties

Name	Type	Description
Name	String	The name of the leaderboard
Version	int32	The version of the leaderboard
Metadata	String	Custom metadata associated with the entity
Rank	int32	The rank of the entity in the leaderboard
Scores	int32[]	The scores of the entity in the leaderboard

Common Properties

All V2 PlayStream events are formatted as JSON objects and most share the following common properties:

Name	Type	Description
SchemaVersion	String	PlayStream event format version, following a semantic versioning scheme.
FullName	Object	Combination of the event name and event namespace to fully specify the event type.
Id	String	PlayFab-assigned unique identifier for this event.
Timestamp	DateTime	The time (in UTC) associated with this event.
Entity	Object	Details about the entity to which this event applies including Entity Id and Entity type.
Originator	Object	Object describing the source and source type that initiated this event.
PayloadContentType	String	Specifies the content of the event payload. Default is “JSON”.
Origin Info	Object	Optional field containing info about events originating outside of PlayFab.

Last modified on August 3, 2026

Related topics

PlayStream event model reference for PlayFab Leaderboards with PlayStream and Telemetry Limits on Leaderboards PFLeaderboardsLeaderboardEntityRankOnVersionEndConfig leaderboard_version_ended

⌘I