# \*Leaderboard by factors

## Leaderboard

<mark style="color:blue;">`GET`</mark> `https://leaderboard.telematicssdk.com/v1/Leaderboard`

This endpoint allows you to get a list of users with ranks\
\
**Authorization:** Allow Anonymous

#### Query Parameters

| Name            | Type    | Description                                                                                                                                                                                             |
| --------------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| UsersCount      | integer | Number of TOP-X users. If you want to show TOP-5 users - UserCount = 5.                                                                                                                                 |
| RoundUsersCount | integer | Number of users around the requested user position.                                                                                                                                                     |
| ScoringRate     | integer | <p>1 - Acceleration score<br>2 - Braking Score<br>3 - Phone Usage Score<br>4 - Speeding Score<br>5 - Cornering Score<br>6 - Overall Score<br>7 - Distance <br>8 - Number of Trips<br>9 Driving Time</p> |

#### Headers

| Name        | Type   | Description      |
| ----------- | ------ | ---------------- |
| DeviceToken | string | User deviceToken |

{% tabs %}
{% tab title="200 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": []
}
```

{% endtab %}
{% endtabs %}

{% hint style="info" %}
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.
{% endhint %}

{% hint style="success" %}
The leaderboard contains ranking information based on the last 14 days driving data.
{% endhint %}

![](https://2858820347-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-LtaiRtygxVgZO0fJZJ-%2F-M2RNAIUt_PSl06ng2TR%2F-M2RQFVbZI-fXAIgivFw%2FLeaderboard_pic.png?alt=media\&token=c8de13b9-b0d5-4704-9dd5-28a7b15c1aca)
