> For the complete documentation index, see [llms.txt](https://docs-old.telematicssdk.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs-old.telematicssdk.com/platform-features/leaderboard-1/leaderboard.md).

# \*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 %}

![](/files/-M2RQFVbZI-fXAIgivFw)


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs-old.telematicssdk.com/platform-features/leaderboard-1/leaderboard.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.