Create Leaderboard Definition
Creates a new leaderboard definition.
Allowed entity token types: title, game_server
Error codes
This operation may return the following PlayFab errors:
| Error | Code |
|---|---|
| ApiNotEnabledForTitle | 1520 |
| DuplicateColumnNameFound | 1585 |
| DuplicateLinkedStatisticColumnNameFound | 1589 |
| EntityTypeMismatchWithStatDefinition | 1582 |
| ExternalEntityNotAllowedForTier | 1580 |
| InvalidBaseTimeForInterval | 1581 |
| LeaderboardCountLimitExceeded | 1574 |
| LeaderboardNameConflict | 1569 |
| LeaderboardSizeLimitExceeded | 1575 |
| LinkedStatisticColumnMismatch | 1570 |
| LinkedStatisticColumnNotFound | 1586 |
| LinkedStatisticColumnRequired | 1587 |
| LinkingStatsNotAllowedForEntityType | 1573 |
| MaxQueryableVersionsExceeded | 23015 |
| MaxQueryableVersionsValueNotAllowedForTier | 1591 |
| MultipleLinkedStatisticsNotAllowed | 1588 |
| PlayFabErrorEventNotSupportedForEntityType | 23013 |
| StatDefinitionAlreadyLinkedToLeaderboard | 1572 |
| StatisticNotFound | 1195 |
| VersionConfigurationIsRequired | 23005 |
Authorizations
This API requires an Entity Session Token, available from the Entity GetEntityToken method.
Body
Leaderboard columns describing the sort directions, cannot be changed after creation. A maximum of 5 columns are allowed.
The entity type being represented on the leaderboard. If it doesn't correspond to the PlayFab entity types, use 'external' as the type.
A name for the leaderboard, unique per title.
Maximum number of entries on this leaderboard
The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
[In Preview]: The configuration for the events emitted by this leaderboard. If not specified, no events will be emitted.
The version reset configuration for the leaderboard definition.
