leaderboard.aroundYou (socialNetwork.leaderboard.aroundYou)
Returns leaderboard data (a list of standings containing uid, score and rank) of users ranked around the current user. 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 < optional> The number of standings that will be returned. Size is required if you are not using the filter parameter
- Integer Array < optional> If provided, the leaderderboard will only contain standings for these users. The size parameter will be ignored when filter is set.
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.