Публичный API [3.0]: Пробег и скорость за период
Описание метода
Метод применяется для получения статистик пробега и скорости ТС за период.
Предусловия
- Требуется аутентификация
- Требуется OAuth 2.0 scope "units:read"
Допустимое количество машино-дней для метода - не более 10000
Формат запроса (Request body)
Метод запроса: POST/statistics/units/mileage-and-speed
Метод доступен по ссылке.
| Атрибут | Тип | Обязательность | Описание |
| unitIds | UUID[] | Да | Массив идентификаторов ТС, для которых строится отчёт |
| dateFrom | String | Да | Дата и время начала периода, за который строится отчёт. ISO 8601 с обязательным указанием offset |
| dateTo | String | Да | Дата и время конца периода, за который строится отчёт. ISO 8601 с обязательным указанием offset |
Пример запроса:
{
"unitIds": [
"3fa85f64-5717-4562-b3fc-2c963f66afa6"
],
"dateFrom": "2026-05-06T06:53:32.256Z",
"dateTo": "2026-05-06T06:53:32.256Z"
}
Формат ответа (Responses Code)
В случае успеха метод возвращает ответ с кодом 200 и телом ответа в формате JSON:
| Атрибут | Тип | Обязательность | Описание | ||
| units | Object[] | Да | Массив результатов по ТС | ||
| id | UUID | Да | Идентификатор ТС | ||
| status | enum UnitReportStatus Success FailureNotFound FailureNoTerminal FailureNoSettings NoData |
Да | Статус | ||
| result | Object | "Да" для status = Success, не заполняется для остальных |
Результаты запроса по ТС | ||
| movementDistanceNavigation | Double | Да | Суммарный пробег макропериодов Movement | ||
| breakDistanceNavigation | Double | Да | Суммарный пробег макропериодов Break | ||
| maxMovementSpeedKmh | Double | Нет | Максимальная скорость в движении | ||
| maxBreakSpeedKmh | Double | Нет | Максимальная скорость в разрывах | ||
| averageSpeedKmh | Double | Нет | Средняя скорость (по макропериодам Movement) | ||
| movementTime | Integer | Да | Время в движении (по макропериодам Movement) | ||
| idleTime | Integer | Да | Время на холостом ходу в секундах | ||
| breakTime | Integer | Да | Время в разрыве в секундах | ||
| firstOdometer | Object | Нет | Первое показание одометра | ||
| timestamp | String | Да | Дата и время показания. ISO 8601 | ||
| value | Double | Да | Показание датчика | ||
| lastOdometer | Object | Нет | Последнее показание одометра | ||
| timestamp | String | Да | Дата и время показания. ISO 8601 | ||
| value | Double | Да | Показание датчика | ||
| distanceOdometer | Double | Нет | Пробег по одометру | ||
Пример ответа:
{
"units": [
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"status": "Success",
"result": {
"movementDistanceNavigation": 0,
"breakDistanceNavigation": 0,
"maxMovementSpeedKmh": 0,
"maxBreakSpeedKmh": 0,
"averageSpeedKmh": 0,
"movementTime": 0,
"idleTime": 0,
"breakTime": 0,
"firstOdometer": {
"timestamp": "2026-05-06T07:28:35.841Z",
"value": 0
},
"lastOdometer": {
"timestamp": "2026-05-06T07:28:35.841Z",
"value": 0
},
"distanceOdometer": 0
}
}
]
}
В случае ошибок авторизации или валидации запроса метод возвращает код, соответствующий ошибке, и тело в формате JSON, соответствующее формату Problem Details:
| Тело ответа | Тип | Обязательность | Описание | |
| type | String | Да | Тип ошибки | |
| title | String | Да | Человекочитаемая расшифровка типа ошибки (универсальная для всех запросов) | |
| detail | String | Нет | Комментарий к ошибке (специфичный для этого запроса) | |
| errors | Object[] | Нет | Массив детализированных ошибок | |
| key | String[] | Да | Тип ошибки | |
| 401 | Unautorized | Токен невалидный или истек срок действия | ||
| 400 | Format | Некорректный формат query параметра | ||
| 500 | InternalError | Произвольная ошибка на сервере | ||
| values | String[] | Да | Список сообщений к данной ошибке | |