Player Data Management - Get Friend Leaderboard

GetLeaderboardResult

Note: the user's Position is relative to the overall leaderboard.

ApiErrorWrapper

This is the outer wrapper for all responses with errors

string

UTC time stamp of attribution

string

Attribution campaign identifier

string

Attribution network name

integer

Numerical HTTP code

string

Playfab error code

integer

Numerical PlayFab error code

object

Detailed description of individual issues with the request object

string

Description for the PlayFab errorCode

string

String HTTP code

string

The email address

string

The name of the email info data

EmailVerificationStatus

The verification status of the email

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

object

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

ExternalFriendSources

Indicates which other platforms' friends should be included in the response. In HTTP, it is represented as a comma-separated list of platforms.

number

Maximum number of entries to retrieve. Default 10, maximum 100.

PlayerProfileViewConstraints

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.

number

Position in the leaderboard to start this listing (defaults to the first entry).

string

Statistic used to rank friends for this leaderboard.

boolean

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

number

The version of the leaderboard to get.

string

Xbox token if Xbox friends should be included. Requires Xbox be configured on PlayFab.

PlayerLeaderboardEntry[]

Ordered listing of users and their positions in the requested leaderboard.

string

The time the next scheduled reset will occur. Null if the leaderboard does not reset on a schedule.

number

The version of the leaderboard returned.

string

Linked account email of the user on the platform, if available

LoginIdentityProvider

Authentication platform

string

Unique account identifier of the user on the platform

string

Linked account username of the user on the platform, if available

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

number

Latitude coordinate of the geographic location.

number

Longitude coordinate of the geographic location.

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

string

boolean

Whether this membership is active. That is, whether the MembershipExpiration time has been reached.

string

The time this membership expires

string

The id of the membership

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.

boolean

Whether the override expiration is set.

SubscriptionModel[]

The list of subscriptions that this player has for this membership

string

Title-specific display name of the user for this leaderboard entry.

string

PlayFab unique identifier of the user for this leaderboard entry.

number

User's overall position in the leaderboard.

PlayerProfileModel

The profile of the user, if requested.

number

Specific value of the user's statistic.

AdCampaignAttributionModel[]

List of advertising campaigns the player has been attributed to

string

URL of the player's avatar image

string

If the player is currently banned, the UTC Date when the ban expires

ContactEmailInfoModel[]

List of all contact email info associated with the player account

string

Player record created

string

Player display name

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.

string

UTC time when the player most recently logged in to the title

LinkedPlatformAccountModel[]

List of all authentication systems linked to this player account

LocationModel[]

List of geographic locations from which the player has logged in to the title

MembershipModel[]

List of memberships for the player, along with whether are expired.

LoginIdentityProvider

Player account origination

string

PlayFab player account unique identifier

string

Publisher this player belongs to

PushNotificationRegistrationModel[]

List of configured end points registered for sending the player push notifications

StatisticModel[]

List of leaderboard statistic values for the player

TagModel[]

List of player's tags for segmentation

string

Title ID this player profile applies to

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.

ValueToDateModel[]

List of the player's lifetime purchase totals, summed by real-money currency

boolean

Whether to show player's avatar URL. Defaults to false

boolean

Whether to show the banned until time. Defaults to false

boolean

Whether to show campaign attributions. Defaults to false

boolean

Whether to show contact email addresses. Defaults to false

boolean

Whether to show the created date. Defaults to false

boolean

Whether to show the display name. Defaults to false

boolean

Whether to show player's experiment variants. Defaults to false

boolean

Whether to show the last login time. Defaults to false

boolean

Whether to show the linked accounts. Defaults to false

boolean

Whether to show player's locations. Defaults to false

boolean

Whether to show player's membership information. Defaults to false

boolean

Whether to show origination. Defaults to false

boolean

Whether to show push notification registrations. Defaults to false

boolean

Reserved for future development

boolean

Whether to show tags. Defaults to false

boolean

Whether to show the total value to date in usd. Defaults to false

boolean

Whether to show the values to date. Defaults to false

string

string

string

Notification configured endpoint

PushNotificationPlatform

Push notification platform

string

Statistic name

number

Statistic value

number

Statistic version (0 if not a versioned statistic)

string

When this subscription expires.

string

The time the subscription was orignially purchased

boolean

Whether this subscription is currently active. That is, if Expiration > now.

SubscriptionProviderStatus

The status of this subscription, according to the subscription provider.

string

The id for this subscription

string

The item id for this subscription from the primary catalog

string

The provider for this subscription. Apple or Google Play are supported today.

string

string

string

string

string

string

string

string

string

Full value of the tag, including namespace

string

ISO 4217 code of the currency used in the purchases

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')

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'.