> ## Documentation Index
> Fetch the complete documentation index at: https://devdocs.xbox.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Leaderboards with PlayStream and Telemetry

> Emit PlayFab leaderboard version-ended and entity rank events to PlayStream or Telemetry to trigger CloudScript, Azure Functions, or reward top players.

With Leaderboards integration to [PlayStream](/services/playfab/data-analytics/ingest-data/playstream-overview), you can easily leverage the real-time event ingestion and processing pipeline to build custom player experiences that are triggered when a Leaderboard version changes. With [PlayStream Actions and Rules](/services/playfab/data-analytics/acting-data/action-rules-quickstart), you can trigger custom [CloudScripts](/services/playfab/live-service-management/service-gateway/automation/cloudscript) or [Azure Functions](/services/playfab/live-service-management/service-gateway/automation/cloudscript-af) to drive engagement and retention features like [granting rewards](/services/playfab/economy-monetization/economy-v2/inventory) to top players, sending personalized notifications to players, or performing score validation to check for cheaters. PlayStream Events will also be archived in Data Explorer for data analytics and warehousing.

And if you want just the data analytics and warehousing without the real-time event actions, Leaderboards has an integration with [Telemetry Events](/services/playfab/data-analytics/ingest-data/telemetry-overview) to provide just the analytics features.

Leaderboards provides two optional events:

* [`playfab.leaderboard.leaderboard_version_ended`](/services/playfab/api-references/events/Leaderboards/leaderboard-version-ended)
* [`playfab.leaderboard.entity_rank_on_leaderboard_version_ended`](/services/playfab/api-references/events/Leaderboards/entity-rank-on-leaderboard-version-ended)

These two events allow you to quickly know when a leaderboard version has ended and allow you to query previous data as soon as you want. With entity rank on leaderboard version ended, you can get the rank and score of the top entity for a leaderboard when that leaderboard version ended.

## Enable PlayStream or Telemetry Events

You can enable events when creating a new leaderboard or editing and existing leaderboard definition. Find the section for PlayStream and telemetry event configuration and select None, PlayStream, or Telemetry.

<img src="https://mintcdn.com/microsoft-4404708b/5IpvKlT-jmAaVkeY/images/playfab/community/leaderboards/create-leaderboard-with-events.png?fit=max&auto=format&n=5IpvKlT-jmAaVkeY&q=85&s=c45d0ef67226e657e6e7c272ea3c0279" alt="This image displays a configuration screen for setting up event parameters, including reset frequency, leaderboard events, and entity rank limits." width="1157" height="830" data-path="images/playfab/community/leaderboards/create-leaderboard-with-events.png" />

> **Note:** Preexisting leaderboards will have both leaderboard version ended and entity rank on leaderboard version ended events turned off by default. If you want to enable them or just one of them, please go to the leaderboard you want to modify and enable that setting.

Once submitted, events be emitted whenever a leaderboard version changes.

## Event Usage

For learning more about how to leverage these events to perform different actions such as connecting to an Azure Function, please check out these resources:

* [Using CloudScript actions with PlayStream](/services/playfab/data-analytics/acting-data/action-rules-using-cloudscript-actions-with-playstream)
* [Quickstart: Writing a PlayFab CloudScript using Azure Functions](/services/playfab/live-service-management/service-gateway/automation/cloudscript-af/quickstart)
* [CloudScript quickstart](/services/playfab/live-service-management/service-gateway/automation/cloudscript/quickstart)

## Restrictions & Notes

* The `playfab.leaderboard.entity_rank_on_leaderboard_version_ended` event, will only return up to the top 1000 ranks.

* The `playfab.leaderboard.entity_rank_on_leaderboard_version_ended` event, will send an event for every entry within the leaderboard.

* The `playfab.leaderboard.entity_rank_on_leaderboard_version_ended` event, will not work with leaderboards with a entity type of `master_player_account` or `external`.

## See Also

* [`playfab.leaderboard.leaderboard_version_ended`](/services/playfab/api-references/events/Leaderboards/leaderboard-version-ended)
* [`playfab.leaderboard.entity_rank_on_leaderboard_version_ended`](/services/playfab/api-references/events/Leaderboards/entity-rank-on-leaderboard-version-ended)
* [PlayStream Overview](/services/playfab/data-analytics/ingest-data/playstream-overview)
* [Statistics with PlayStream and Telemetry](/services/playfab/player-progression/statistics/statistics-with-playstream-and-telemetry).
* [Telemetry Overview](/services/playfab/data-analytics/ingest-data/telemetry-overview)
* [Pricing Meters](/services/playfab/pricing/meters/meters)
* [PlayStream Event Capabilities](/services/playfab/data-analytics/ingest-data/playstream-event-capabilities)
* [Using CloudScript actions with PlayStream](/services/playfab/data-analytics/acting-data/action-rules-using-cloudscript-actions-with-playstream)
* [Quickstart: Writing a PlayFab CloudScript using Azure Functions](/services/playfab/live-service-management/service-gateway/automation/cloudscript-af/quickstart)
* [CloudScript quickstart](/services/playfab/live-service-management/service-gateway/automation/cloudscript/quickstart)
* [Limits on Leaderboards](/services/playfab/community/leaderboards/limits-leaderboards)
* [Leaderboards and Cloudscript](/services/playfab/community/leaderboards/leaderboards-cloudscript).


## Related topics

- [Statistics with PlayStream and Telemetry](/services/playfab/player-progression/statistics/statistics-with-playstream-and-telemetry.md)
- [PlayFab Leaderboards overview](/services/playfab/community/leaderboards/index.md)
- [Game Saves PlayStream events](/services/playfab/player-progression/game-saves/playstream-events.md)
- [PlayStream event model reference for PlayFab](/services/playfab/api-references/events/index.md)
- [Insights Best Practices](/services/playfab/data-analytics/legacy/insights/best-practices.md)
