leaderboard.topScores (socialNetwork.leaderboard.topScores)

Returns leaderboard data (a list of standings containing uid, score and rank) of top ranked users. The optional name parameter indicates a leaderboard within your app, it could represent a game, a level within a game or a time-limited scoreboard (July scores, for example), if not set the default leaderboard for your app will be returned. Scores retrieved through leaderboard APIs have a small delay of a few seconds, to get real time scores use instead the score APIs.

Parameters

  • String < optional> The type of score. Can be either high (default) or cumulative.
  • String < optional> An indicator for which scoreboard you would like to get the results from.
  • Integer < required> The number of standings that will be returned.

Other parameters required to make this API method call

  • String < required> The api key of the current app.
  • String < required> The current user's session key.
  • Decimal < required> The sequence number for this request. This must be greater than the value provided for the previous call. Tip: Server time in milliseconds is ideal for this.
  • String < required> The signature for the current request.
  • String < required> Set this to 1.0 for now.
  • String < optional> Response format, accepts XML or JSON, default is XML.
  • String < optional> Generates a call to the callback containing the formatted results.