Параметры запросов и доступные метрики
При выполнении запросов к BI Analytics API необходимо указать параметры, определяющие, какие данные получить и в каком виде их вернуть.
Кроме параметров запроса, необходимо выбрать метрики — показатели, которые будут включены в результат. Именно они определяют, какие данные вернёт API, например пробег, расход топлива, количество поездок или нарушения экодрайвинга.
Параметры запроса определяют источник данных, способ их группировки и дополнительные условия выборки.
source
Поле source определяет, по каким данным строить выборку.
Доступные значения:
-
vehicle — данные по транспорту
-
driver — данные по водителям
group_by
Поле group_by определяет, как группировать результат.
|
Значение
|
Что показывает
|
Пример структуры ответа
|
|
total
|
Сумма по всем авто или водителям за период
|
{ "metric": 123 }
|
|
day
|
Сумма по всем авто или водителям за каждый день
|
{ "20260301": { "metric": 123 } }
|
|
rating
|
Каждый источник, итог за период
|
{ source_id: { "metric": 123 } }
|
|
source_day
|
Каждый источник, каждый день
|
{ source_id: { "20260301": { "metric": 123 } } }
|
ACCOUNT_ID
Параметр ACCOUNT_ID позволяет ограничить выгрузку данными одного договора.
Если в запросе указаны логин и пароль партнёрского аккаунта, без ACCOUNT_ID система выгружает все транспортные средства по всем договорам, доступным этому партнёру.
Если в запросе указать ACCOUNT_ID, будут загружены только объекты выбранного договора.
Метрики определяют, какие показатели будут возвращены API. Они передаются в параметре metrics в виде списка.
Например:
metrics = [
"veh_driving_dist",
"veh_fuel_cons",
"average_speed"
]
|
Ниже приведён список поддерживаемых метрик.
Транспорт — общее
|
Параметр
|
Описание
|
|
veh_trips_cnt
|
Количество поездок
|
|
veh_driving_dist
|
Пробег (км)
|
|
veh_driving_time
|
Время в движении
|
|
veh_parking_time
|
Время стоянок
|
|
veh_ignition_time
|
Время с включённым зажиганием
|
|
veh_idle_time
|
Время холостого хода
|
|
veh_motor_hours
|
Моточасы
|
Транспорт — топливо
|
Параметр
|
Описание
|
|
veh_fuel_cons
|
Расход топлива
|
|
veh_fuel_filled
|
Заправлено топлива
|
|
veh_fuel_drained
|
Слито топлива
|
Транспорт — нарушения
|
Параметр
|
Описание
|
|
veh_eco_fine
|
Штраф за эко-вождение
|
|
veh_eco_cnt
|
Количество нарушений эко-вождения
|
|
veh_acc_fine
|
Штраф за резкие ускорения
|
|
veh_acc_cnt
|
Количество резких ускорений
|
|
veh_braking_fine
|
Штраф за резкое торможение
|
|
veh_braking_cnt
|
Количество резких торможений
|
|
veh_turn_fine
|
Штраф за резкие повороты
|
|
veh_turn_cnt
|
Количество резких поворотов
|
|
veh_speed_fine
|
Штраф за превышение скорости
|
|
veh_speed_cnt
|
Количество превышений скорости
|
|
veh_belt_fine
|
Штраф за непристёгнутый ремень
|
|
veh_belt_cnt
|
Количество нарушений ремня
|
|
veh_idle_fine
|
Штраф за холостой ход
|
|
veh_idle_cnt
|
Количество нарушений холостого хода
|
Транспорт — затраты
|
Параметр
|
Описание
|
|
veh_fuel_cost_per_kilometer
|
Стоимость топлива на км
|
|
veh_service_cost_per_kilometer
|
Стоимость обслуживания на км
|
|
veh_amount_exp
|
Общие расходы
|
|
cost_of_using
|
Стоимость использования
|
|
average_speed
|
Средняя скорость
|
|
veh_cars_counter
|
Количество авто
|
Водители
|
Параметр
|
Описание
|
|
drv_trips_cnt
|
Количество поездок
|
|
drv_driving_dist
|
Пробег (км)
|
|
drv_driving_time
|
Время в движении
|
|
drv_parking_time
|
Время стоянок
|
|
drv_fuel_cons
|
Расход топлива
|
|
drv_fuel_filled
|
Заправлено топлива
|
|
drv_fuel_drained
|
Слито топлива
|
|
drv_eco_fine
|
Штраф за эко-вождение
|
|
drv_eco_cnt
|
Количество нарушений эко-вождения
|
|
drv_acc_fine
|
Штраф за резкие ускорения
|
|
drv_acc_cnt
|
Количество резких ускорений
|
|
drv_braking_fine
|
Штраф за резкое торможение
|
|
drv_braking_cnt
|
Количество резких торможений
|
|
drv_turn_fine
|
Штраф за резкие повороты
|
|
drv_turn_cnt
|
Количество резких поворотов
|
|
drv_speed_fine
|
Штраф за превышение скорости
|
|
drv_speed_cnt
|
Количество превышений скорости
|
|
drv_belt_fine
|
Штраф за непристёгнутый ремень
|
|
drv_belt_cnt
|
Количество нарушений ремня
|
Метрики для отдельных типов eco-событий
Для получения данных по отдельным типам событий Экодрайвинга используются метрики следующего формата:
-
eco_{N}_fine — — количество штрафных баллов по типу события
-
eco_{N}_cnt— количество зарегистрированных событий данного типа
Здесь N — это идентификатор (ID) типа события качества вождения.
Каждый тип события имеет собственный уникальный ID, который система автоматически присваивает при его создании. Этот идентификатор используется в API для формирования названий метрик.
Например, в справочнике типов качества вождения стандартные события могут иметь следующие идентификаторы:
|
ID
|
Тип события
|
|
1
|
Acceleration
|
|
2
|
Braking
|
|
3
|
Turn
|
|
4
|
Speed
|
|
5
|
Seat Belt
|
Если в системе созданы собственные типы событий, им также автоматически присваиваются уникальные ID.
При формировании запроса вместо N необходимо указать ID нужного типа события.
Примеры
|
Параметр
|
Что возвращает
|
|
eco_1_fine / eco_1_cnt
|
Штрафные баллы и количество событий Acceleration
|
|
eco_2_fine / eco_2_cnt
|
Штрафные баллы и количество событий Braking
|
|
eco_4_fine / eco_4_cnt
|
Штрафные баллы и количество событий Speed
|
|
eco_5_fine / eco_5_cnt
|
Штрафные баллы и количество событий Seat Belt
|
Посмотреть идентификаторы типов событий можно в справочнике «Типы качества вождения». Значение отображается в колонке ID. При создании нового типа система автоматически присваивает ему уникальный идентификатор, который затем используется в метриках BI Analytics API.
|