跳转到主要内容
POST
Get Leaderboard

授权

X-SecretKey
string
header
必填

This API requires a title secret key, available to title admins, from PlayFab Game Manager.

请求体

application/json
MaxResultsCount
number
必填

Maximum number of entries to retrieve.

StartPosition
number
必填

First entry in the leaderboard to be retrieved.

StatisticName
string
必填

Unique identifier for the title-specific statistic for the leaderboard.

CustomTags
object

The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).

ProfileConstraints
object

If non-null, this determines which properties of the resulting player profiles to return. For API calls from the client, only the allowed client profile properties for the title may be requested. These allowed properties are configured in the Game Manager "Client Profile Options" tab in the "Settings" section.

UseSpecificVersion
boolean

If set to false, Version is considered null. If true, uses the specified Version

Version
number

The version of the leaderboard to get.

响应

Note that the Position of the user in the results is for the overall leaderboard.

code
integer

The Http status code. If X-ReportErrorAsSuccess header is set to true, this will report the actual http error code.

status
string

The Http status code as a string.

data
object

Note that the Position of the user in the results is for the overall leaderboard.

示例:
最后修改于 2026年10月6日