×

Получение отчёта

Этот API формирует отчёт по транспортным средствам, водителям, зонам, клиентам или тегам за выбранный период времени с возможностью детальной настройки содержимого.

Как получить данные

Адрес запроса

Для получения данных используйте адрес: https://<server_address>/api/api.php?

Метод запроса

GET или POST

Параметры запроса

Обязательные:
  • cmd=get_report — команда для получения отчёта
  • report_type — тип отчёта (числовой идентификатор)
  • start — начало периода (Unix timestamp)
  • stop — конец периода (Unix timestamp)
  • veh_id — идентификаторы транспортных средств (через запятую)
  • explode — разделение данных по: 1 — дни, 2 — недели, 3 — не разделять
  • group — группировка данных: 1 — по дням, 2 — по объектам, 3 — по зонам, 4 — по водителям, 5 — по клиентам, 6 — по группам, 7 — по тегам
  • format — формат отчёта: json, pdf, xls
  • tz — часовой пояс отчёта (например, Africa/Johannesburg)
Дополнительные:
  • drivers_id — список ID водителей
  • zones_id — список ID геозон
  • fillings — включить данные о заполнениях
  • stales — включить стоки
  • speed — включить скорость
  • rashod — включить расход топлива
  • stops — включить остановки
  • run — включить запуски транспортных средств
  • contr_time / type — контрольное время
  • tags — список ID тегов
  • template — ID шаблона отчета
  • outside_zones — включить внешние зоны
  • work_hours — учитывать только рабочие часы
  • fuel — включить топливо
  • vehicle_not_moving_time — время простоя для отчёта
  • vehicles_has_covered_km — пробег транспортного средства
  • notifications — список ID уведомлений
 

Пример GET-запроса

https://<server_address>/api/api.php?cmd=get_report&report_type=1&start=1724623200&stop=1724709600&veh_id=1234,5678&explode=1&group=2
&format=json&tz=Africa/Johannesburg&node=1

Пример POST-запроса

{
    "cmd": "get_report",
    "report_type": 1,
    "start": 1724623200,
    "stop": 1724709600,
    "veh_id": "1234,5678",
    "explode": 1,
    "group": 2,
    "format": "json",
    "tz": "Africa/Johannesburg"
}
Ответ
{
  "code": 0,
  "msg": "OK",
  "data": [
    {
      "veh_id": "1234",
      "date": "2025-09-22",
      "distance": 125.5,
      "fuel_consumption": 15.2,
      "stops": 5,
      "speed_avg": 60
    },
    {
      "veh_id": "5678",
      "date": "2025-09-22",
      "distance": 98.3,
      "fuel_consumption": 12.7,
      "stops": 4,
      "speed_avg": 55
    }
  ]
}
 
В ответ на API-запрос возвращается:
  • code — код результата (0 — успешная операция)
  • msg — сообщение сервера
  • data — массив данных отчёта
  • veh_id — идентификатор транспортного средства
  • date — дата записи отчёта
  • distance — пройденный путь (км)
  • fuel_consumption — расход топлива
  • stops — количество остановок
  • speed_avg — средняя скорость