Публичный API [3.0]: Пробег за период

Описание метода

Метод применяется для получения посуточных статистик пробега ТС за период. Источник показаний по пробегу определяется в зависимости от настроек фильтрации (если проставлен чек-бокс "Использовать датчик одометра для расчета пробега", будут указаны показания пробега с одометра).

Предусловия

  • Требуется аутентификация
  • Требуется OAuth 2.0 scope "units:read"

Допустимое количество машино-дней для метода - не более 370 000

Формат запроса (Request body)

Метод запроса: POST/statistics/units/daily-mileage
Метод доступен по ссылке.

Атрибут Тип Обязательность Описание
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: 
  • Success
  • FailureNotFound
  • FailureNoTerminal
  • FailureNoSettings
  • NoData
Да Статус
  result Object "Да" для status = Success, не заполняется для остальных Результаты запроса по ТС
    days Object[] Да Массив данных по дням за период
      begin String Да Дата суточного блока. ISO 8601, дата без времени
      movementGpsDistanceKm Double Да Пробег по GPS
      odometerDistanceKm Double Нет Пробег по одометру
      distanceKm Double Да Пробег за сутки ТС
Пример ответа:
{
"units": [
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"status": "Success",
"result": {
"days": [
{
"begin": "2026-10-01",
"movementGpsDistanceKm": 0,
"odometerDistanceKm": 0,
"distanceKm": 0
}
]
}
}
]
}

В случае ошибок авторизации или валидации запроса метод возвращает код, соответствующий ошибке, и тело в формате JSON, соответствующее формату Problem Details:

Тело ответа Тип Обязательность Описание
type String Да Тип ошибки
title String Да Человекочитаемая расшифровка типа ошибки (универсальная для всех запросов)
detail String Нет Комментарий к ошибке (специфичный для этого запроса)
errors Object[] Нет Массив детализированных ошибок
  key String[] Да Тип ошибки
401  Unautorized     Токен невалидный или истек срок действия
400 Format     Некорректный формат query параметра
500 InternalError     Произвольная ошибка на сервере
  values String[] Да Список сообщений к данной ошибке