Return to Top ^
Loads a list of score
objects from a scoreboard. Use 'skip' and 'limit' for getting different pages.
The numeric ID of the scoreboard.
An integer indicating the number of scores to include in the list. Default = 10. (optional)
The time-frame to pull scores from (see notes for acceptable values). (optional)
An integer indicating the number of scores to skip before starting the list. Default = 0. (optional)
If set to true, only social scores will be loaded (scores by the user and their friends). This param will be ignored if there is no valid session id and the 'user' param is absent. (optional)
A tag to filter results by. (optional)
A user's ID or name. If 'social' is true, this user and their friends will be included. Otherwise, only scores for this user will be loaded. If this param is missing and there is a valid session id, that user will be used by default. (optional)
The query skip that was used.
The time-frame the scores belong to. See notes for acceptable values.
An array of score
Will return true if scores were loaded in social context ('social' set to true and a session or 'user' were provided).
the score list is associated with (either as defined in the 'user' param, or extracted from the current session when 'social' is set to true)
Acceptable 'period' values:
"D" = current day (default)
"W" = current week
"M" = current month
"Y" = current year
"A" = all-time
If 'social' is true, but no 'user' is provided,