Player Data Management - Get Friend Leaderboard
Retrieves a list of ranked friends of the current player for the given statistic, starting from the indicated point in the leaderboard
POST https://titleId.playfabapi.com/Client/GetFriendLeaderboardRequest Header
| Name | Required | Type | Description |
|---|---|---|---|
| X-Authorization | True |
string |
This API requires a client session ticket, available from any Client Login function. |
Request Body
| Name | Required | Type | Description |
|---|---|---|---|
| StartPosition | True |
number |
Position in the leaderboard to start this listing (defaults to the first entry). |
| StatisticName | True |
string |
Statistic used to rank friends for this leaderboard. |
| CustomTags |
object |
The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). |
|
| ExternalPlatformFriends |
Indicates which other platforms' friends should be included in the response. In HTTP, it is represented as a comma-separated list of platforms. |
||
| MaxResultsCount |
number |
Maximum number of entries to retrieve. Default 10, maximum 100. |
|
| ProfileConstraints |
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. |
|
| XboxToken |
string |
Xbox token if Xbox friends should be included. Requires Xbox be configured on PlayFab. |
Responses
| Name | Type | Description |
|---|---|---|
| 200 OK |
Note: the user's Position is relative to the overall leaderboard. |
|
| 400 Bad Request |
This is the outer wrapper for all responses with errors |
Security
X-Authorization
This API requires a client session ticket, available from any Client Login function.
Type:
apiKey
In:
header
Definitions
| Name | Description |
|---|---|
|
Ad |
|
|
Api |
The basic wrapper around every failed API response |
|
Contact |
|
|
Continent |
|
|
Country |
|
|
Email |
|
|
External |
|
|
Get |
|
|
Get |
Note: the user's Position is relative to the overall leaderboard. |
|
Linked |
|
|
Location |
|
|
Login |
|
|
Membership |
|
|
Player |
|
|
Player |
|
|
Player |
|
|
Push |
|
|
Push |
|
|
Statistic |
|
|
Subscription |
|
|
Subscription |
|
|
Tag |
|
|
Value |
AdCampaignAttributionModel
| Name | Type | Description |
|---|---|---|
| AttributedAt |
string |
UTC time stamp of attribution |
| CampaignId |
string |
Attribution campaign identifier |
| Platform |
string |
Attribution network name |
ApiErrorWrapper
The basic wrapper around every failed API response
| Name | Type | Description |
|---|---|---|
| code |
integer |
Numerical HTTP code |
| error |
string |
Playfab error code |
| errorCode |
integer |
Numerical PlayFab error code |
| errorDetails |
object |
Detailed description of individual issues with the request object |
| errorMessage |
string |
Description for the PlayFab errorCode |
| status |
string |
String HTTP code |
ContactEmailInfoModel
| Name | Type | Description |
|---|---|---|
| EmailAddress |
string |
The email address |
| Name |
string |
The name of the email info data |
| VerificationStatus |
The verification status of the email |
ContinentCode
| Value | Description |
|---|---|
| AF | |
| AN | |
| AS | |
| EU | |
| NA | |
| OC | |
| SA | |
| Unknown |
CountryCode
| Value | Description |
|---|---|
| AD | |
| AE | |
| AF | |
| AG | |
| AI | |
| AL | |
| AM | |
| AO | |
| AQ | |
| AR | |
| AS | |
| AT | |
| AU | |
| AW | |
| AX | |
| AZ | |
| BA | |
| BB | |
| BD | |
| BE | |
| BF | |
| BG | |
| BH | |
| BI | |
| BJ | |
| BL | |
| BM | |
| BN | |
| BO | |
| BQ | |
| BR | |
| BS | |
| BT | |
| BV | |
| BW | |
| BY | |
| BZ | |
| CA | |
| CC | |
| CD | |
| CF | |
| CG | |
| CH | |
| CI | |
| CK | |
| CL | |
| CM | |
| CN | |
| CO | |
| CR | |
| CU | |
| CV | |
| CW | |
| CX | |
| CY | |
| CZ | |
| DE | |
| DJ | |
| DK | |
| DM | |
| DO | |
| DZ | |
| EC | |
| EE | |
| EG | |
| EH | |
| ER | |
| ES | |
| ET | |
| FI | |
| FJ | |
| FK | |
| FM | |
| FO | |
| FR | |
| GA | |
| GB | |
| GD | |
| GE | |
| GF | |
| GG | |
| GH | |
| GI | |
| GL | |
| GM | |
| GN | |
| GP | |
| GQ | |
| GR | |
| GS | |
| GT | |
| GU | |
| GW | |
| GY | |
| HK | |
| HM | |
| HN | |
| HR | |
| HT | |
| HU | |
| ID | |
| IE | |
| IL | |
| IM | |
| IN | |
| IO | |
| IQ | |
| IR | |
| IS | |
| IT | |
| JE | |
| JM | |
| JO | |
| JP | |
| KE | |
| KG | |
| KH | |
| KI | |
| KM | |
| KN | |
| KP | |
| KR | |
| KW | |
| KY | |
| KZ | |
| LA | |
| LB | |
| LC | |
| LI | |
| LK | |
| LR | |
| LS | |
| LT | |
| LU | |
| LV | |
| LY | |
| MA | |
| MC | |
| MD | |
| ME | |
| MF | |
| MG | |
| MH | |
| MK | |
| ML | |
| MM | |
| MN | |
| MO | |
| MP | |
| MQ | |
| MR | |
| MS | |
| MT | |
| MU | |
| MV | |
| MW | |
| MX | |
| MY | |
| MZ | |
| NA | |
| NC | |
| NE | |
| NF | |
| NG | |
| NI | |
| NL | |
| NO | |
| NP | |
| NR | |
| NU | |
| NZ | |
| OM | |
| PA | |
| PE | |
| PF | |
| PG | |
| PH | |
| PK | |
| PL | |
| PM | |
| PN | |
| PR | |
| PS | |
| PT | |
| PW | |
| PY | |
| QA | |
| RE | |
| RO | |
| RS | |
| RU | |
| RW | |
| SA | |
| SB | |
| SC | |
| SD | |
| SE | |
| SG | |
| SH | |
| SI | |
| SJ | |
| SK | |
| SL | |
| SM | |
| SN | |
| SO | |
| SR | |
| SS | |
| ST | |
| SV | |
| SX | |
| SY | |
| SZ | |
| TC | |
| TD | |
| TF | |
| TG | |
| TH | |
| TJ | |
| TK | |
| TL | |
| TM | |
| TN | |
| TO | |
| TR | |
| TT | |
| TV | |
| TW | |
| TZ | |
| UA | |
| UG | |
| UM | |
| US | |
| UY | |
| UZ | |
| Unknown | |
| VA | |
| VC | |
| VE | |
| VG | |
| VI | |
| VN | |
| VU | |
| WF | |
| WS | |
| YE | |
| YT | |
| ZA | |
| ZM | |
| ZW |
EmailVerificationStatus
| Value | Description |
|---|---|
| Confirmed | |
| Pending | |
| Unverified |
ExternalFriendSources
| Value | Description |
|---|---|
| All | |
| None | |
| Psn | |
| Steam | |
| Xbox |
GetFriendLeaderboardRequest
| Name | Type | Description |
|---|---|---|
| CustomTags |
object |
The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). |
| ExternalPlatformFriends |
Indicates which other platforms' friends should be included in the response. In HTTP, it is represented as a comma-separated list of platforms. |
|
| MaxResultsCount |
number |
Maximum number of entries to retrieve. Default 10, maximum 100. |
| ProfileConstraints |
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. |
|
| StartPosition |
number |
Position in the leaderboard to start this listing (defaults to the first entry). |
| StatisticName |
string |
Statistic used to rank friends for this leaderboard. |
| 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. |
| XboxToken |
string |
Xbox token if Xbox friends should be included. Requires Xbox be configured on PlayFab. |
GetLeaderboardResult
Note: the user's Position is relative to the overall leaderboard.
| Name | Type | Description |
|---|---|---|
| Leaderboard |
Ordered listing of users and their positions in the requested leaderboard. |
|
| NextReset |
string |
The time the next scheduled reset will occur. Null if the leaderboard does not reset on a schedule. |
| Version |
number |
The version of the leaderboard returned. |
LinkedPlatformAccountModel
| Name | Type | Description |
|---|---|---|
|
string |
Linked account email of the user on the platform, if available |
|
| Platform |
Authentication platform |
|
| PlatformUserId |
string |
Unique account identifier of the user on the platform |
| Username |
string |
Linked account username of the user on the platform, if available |
LocationModel
| Name | Type | Description |
|---|---|---|
| City |
string |
City name. |
| ContinentCode |
The two-character continent code for this location |
|
| CountryCode |
The two-character ISO 3166-1 country code for the country associated with the location |
|
| Latitude |
number |
Latitude coordinate of the geographic location. |
| Longitude |
number |
Longitude coordinate of the geographic location. |
LoginIdentityProvider
| Value | Description |
|---|---|
| AndroidDevice | |
| Apple | |
| Custom | |
| CustomServer | |
| FacebookInstantGames | |
| GameCenter | |
| GameServer | |
| GooglePlay | |
| GooglePlayGames | |
| IOSDevice | |
| King | |
| Kongregate | |
| NintendoSwitch | |
| NintendoSwitchAccount | |
| OpenIdConnect | |
| PSN | |
| PlayFab | |
| Steam | |
| Twitch | |
| Unknown | |
| WindowsHello | |
| XBoxLive | |
| XboxMobileStore |
MembershipModel
| Name | Type | Description |
|---|---|---|
| IsActive |
boolean |
Whether this membership is active. That is, whether the MembershipExpiration time has been reached. |
| MembershipExpiration |
string |
The time this membership expires |
| MembershipId |
string |
The id of the membership |
| OverrideExpiration |
string |
Membership expirations can be explicitly overridden (via game manager or the admin api). If this membership has been overridden, this will be the new expiration time. |
| OverrideIsSet |
boolean |
Whether the override expiration is set. |
| Subscriptions |
The list of subscriptions that this player has for this membership |
PlayerLeaderboardEntry
| Name | Type | Description |
|---|---|---|
| DisplayName |
string |
Title-specific display name of the user for this leaderboard entry. |
| PlayFabId |
string |
PlayFab unique identifier of the user for this leaderboard entry. |
| Position |
number |
User's overall position in the leaderboard. |
| Profile |
The profile of the user, if requested. |
|
| StatValue |
number |
Specific value of the user's statistic. |
PlayerProfileModel
| Name | Type | Description |
|---|---|---|
| AdCampaignAttributions |
List of advertising campaigns the player has been attributed to |
|
| AvatarUrl |
string |
URL of the player's avatar image |
| BannedUntil |
string |
If the player is currently banned, the UTC Date when the ban expires |
| ContactEmailAddresses |
List of all contact email info associated with the player account |
|
| Created |
string |
Player record created |
| DisplayName |
string |
Player display name |
| ExperimentVariants |
string[] |
List of experiment variants for the player. Note that these variants are not guaranteed to be up-to-date when returned during login because the player profile is updated only after login. Instead, use the LoginResult.TreatmentAssignment property during login to get the correct variants and variables. |
| LastLogin |
string |
UTC time when the player most recently logged in to the title |
| LinkedAccounts |
List of all authentication systems linked to this player account |
|
| Locations |
List of geographic locations from which the player has logged in to the title |
|
| Memberships |
List of memberships for the player, along with whether are expired. |
|
| Origination |
Player account origination |
|
| PlayerId |
string |
PlayFab player account unique identifier |
| PublisherId |
string |
Publisher this player belongs to |
| PushNotificationRegistrations |
List of configured end points registered for sending the player push notifications |
|
| Statistics |
List of leaderboard statistic values for the player |
|
| Tags |
Tag |
List of player's tags for segmentation |
| TitleId |
string |
Title ID this player profile applies to |
| TotalValueToDateInUSD |
number |
Sum of the player's purchases made with real-money currencies, converted to US dollars equivalent and represented as a whole number of cents (1/100 USD). For example, 999 indicates nine dollars and ninety-nine cents. |
| ValuesToDate |
List of the player's lifetime purchase totals, summed by real-money currency |
PlayerProfileViewConstraints
| Name | Type | Description |
|---|---|---|
| ShowAvatarUrl |
boolean |
Whether to show player's avatar URL. Defaults to false |
| ShowBannedUntil |
boolean |
Whether to show the banned until time. Defaults to false |
| ShowCampaignAttributions |
boolean |
Whether to show campaign attributions. Defaults to false |
| ShowContactEmailAddresses |
boolean |
Whether to show contact email addresses. Defaults to false |
| ShowCreated |
boolean |
Whether to show the created date. Defaults to false |
| ShowDisplayName |
boolean |
Whether to show the display name. Defaults to false |
| ShowExperimentVariants |
boolean |
Whether to show player's experiment variants. Defaults to false |
| ShowLastLogin |
boolean |
Whether to show the last login time. Defaults to false |
| ShowLinkedAccounts |
boolean |
Whether to show the linked accounts. Defaults to false |
| ShowLocations |
boolean |
Whether to show player's locations. Defaults to false |
| ShowMemberships |
boolean |
Whether to show player's membership information. Defaults to false |
| ShowOrigination |
boolean |
Whether to show origination. Defaults to false |
| ShowPushNotificationRegistrations |
boolean |
Whether to show push notification registrations. Defaults to false |
| ShowStatistics |
boolean |
Reserved for future development |
| ShowTags |
boolean |
Whether to show tags. Defaults to false |
| ShowTotalValueToDateInUsd |
boolean |
Whether to show the total value to date in usd. Defaults to false |
| ShowValuesToDate |
boolean |
Whether to show the values to date. Defaults to false |
PushNotificationPlatform
| Value | Description |
|---|---|
| ApplePushNotificationService | |
| GoogleCloudMessaging |
PushNotificationRegistrationModel
| Name | Type | Description |
|---|---|---|
| NotificationEndpointARN |
string |
Notification configured endpoint |
| Platform |
Push notification platform |
StatisticModel
| Name | Type | Description |
|---|---|---|
| Name |
string |
Statistic name |
| Value |
number |
Statistic value |
| Version |
number |
Statistic version (0 if not a versioned statistic) |
SubscriptionModel
| Name | Type | Description |
|---|---|---|
| Expiration |
string |
When this subscription expires. |
| InitialSubscriptionTime |
string |
The time the subscription was orignially purchased |
| IsActive |
boolean |
Whether this subscription is currently active. That is, if Expiration > now. |
| Status |
The status of this subscription, according to the subscription provider. |
|
| SubscriptionId |
string |
The id for this subscription |
| SubscriptionItemId |
string |
The item id for this subscription from the primary catalog |
| SubscriptionProvider |
string |
The provider for this subscription. Apple or Google Play are supported today. |
SubscriptionProviderStatus
| Value | Description |
|---|---|
| BillingError | |
| Cancelled | |
| CustomerDidNotAcceptPriceChange | |
| FreeTrial | |
| NoError | |
| PaymentPending | |
| ProductUnavailable | |
| UnknownError |
TagModel
| Name | Type | Description |
|---|---|---|
| TagValue |
string |
Full value of the tag, including namespace |
ValueToDateModel
| Name | Type | Description |
|---|---|---|
| Currency |
string |
ISO 4217 code of the currency used in the purchases |
| TotalValue |
number |
Total value of the purchases in a whole number of 1/100 monetary units. For example, 999 indicates nine dollars and ninety-nine cents when Currency is 'USD') |
| TotalValueAsDecimal |
string |
Total value of the purchases in a string representation of decimal monetary units. For example, '9.99' indicates nine dollars and ninety-nine cents when Currency is 'USD'. |
Error Codes
| Name | Code |
|---|---|
| ExpiredXboxLiveToken | 1189 |
| FacebookAPIError | 1143 |
| InvalidXboxLiveToken | 1188 |
| LeaderboardVersionNotAvailable | 1277 |
| XboxInaccessible | 1339 |
| XboxServiceTooManyRequests | 1505 |
| XboxXASSExchangeFailure | 1306 |