Leaderboard by factors
Users leaderboard by scoring factors and driving statistics. the leaderboard is calculated based on previous 14 days driving data.
getLeaderboard
get
https://leaderboard.telematicssdk.com/v1/Leaderboard
This endpoint allows you to get a list of users with ranks
Authorization: Allow Anonymous
Request
Response
Request
Headers
DeviceToken
required
string
User deviceToken
Query Parameters
UsersCount
optional
integer
Number of TOP-X users. If you want to show TOP-5 users - UserCount = 5.
RoundUsersCount
optional
integer
Number of users around the requested user position.
ScoringRate
required
integer
1 - Acceleration score
2 - Braking Score
3 - Phone Usage Score
4 - Speeding Score
5 - Cornering Score
6 - Overall Score
7 - Distance
8 - Number of Trips
9 Driving Time
Response
200: OK
Cake successfully retrieved.
{"Result": {"UsersNumber": 61, // Total number of users in respose"ScoringRate": "Acceleration", // Selected factor"Users": [{"DeviceToken": "", // User device token"Nickname": null, //Nickname"FirstName": null,"LastName": null,"Image": "", // avatar image URL"Value": 100, // Factor value"Place": 1, // rank"IsCurrentUser": false //if requested user = true},{"DeviceToken": "","Nickname": null,"FirstName": null,"LastName": null,"Image": "","Value": 100,"Place": 2,"IsCurrentUser": false}]},"Status": 200,"Title": "","Errors": []}
get
get
https://leaderboard.telematicssdk.com/v1/Leaderboard
Request
Response
Request
Body Parameters
UsersCount
optional
integer
Number of TOP-X users. if you want to show TOP-5 users = UserCount = 5
Response
200: OK
in case when a requested user is in a number of UsersCount, the response will contain only Users Count, otherwise it will be combined list UsersCount + RoundUserCount + requested user.
The leaderboard contains ranking information based on the last 14 days driving data.
Request example: curl -X GET "https://leaderboard.telematicssdk.com/v1/Leaderboard?UsersCount=10&RoundUsersCount=5&ScoringRate=1" -H "accept: text/plain" -H "DeviceToken: ab78e08e-173e-4173-9d7f-0bdd0bb201ba"
Swagger: https://leaderboard.telematicssdk.com/swagger/index.html
Last updated 3 months ago