From 5706e65bdf7287a3baaca32fd983edc07397a518 Mon Sep 17 00:00:00 2001 From: Tom Bloor Date: Tue, 13 Jun 2017 23:14:15 +0100 Subject: [PATCH] Updated Leaderboard API (markdown) --- Leaderboard-API.md | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/Leaderboard-API.md b/Leaderboard-API.md index deab7b5..6ff69f6 100644 --- a/Leaderboard-API.md +++ b/Leaderboard-API.md @@ -21,8 +21,8 @@ Where type is one of: * `weekly_count` * `monthly_total` * `monthly_count` -* `global_total` -* `global_count` +* `all_time_total` +* `all_time_count` ### Response JSON @@ -37,7 +37,8 @@ Response code of `200 OK` { display_name : , value : , - trend : + trend : , + position : }, ... ], @@ -47,11 +48,11 @@ Response code of `200 OK` Where trend is: -* `1` : Climbing the Leaderboard +* `1` : Descending the Leaderboard (approaching last) * `0` : No change in Leaderboard position -* `-1` : Descending the Leaderboard +* `-1` : Ascending the Leaderboard (approaching first) -And `user_position` is the place of the user in the leaderboard - *zero indexed*! +And `user_position` is the place of the user in the leaderboard - a result of `0` means they have no position. #### Failure