Описание методов API
/
Скоринг
/
Получить выборку скоринга по месяцам

Exodrive API (2.0)

Download OpenAPI description
swagger.json
swagger.yaml
Languages
Servers
DEV сервер
https://dev.api.exodrive.ai/

Аварии

Operations

Аномалии

Operations

Биллинг

Operations

Устройства

Operations

Ваучеры

Operations

Справочники

Operations

Скоринг

Operations

Получить выборку скоринга по дням

Request

Возвращает агрегированную скоринговую статистику по дням для конкретного ваучера. Опционально включает рекомендации по улучшению вождения.

Query
voucherIdstring

Служебный идентификатор ваучера

daysCountinteger(int32)

Количество дней выборки

skipDaysCountinteger(int32)

Количество дней отступа, по умолчанию 0

Default 0
includeRecommendationsboolean

Включить рекомендации по улучшению вождения (по умолчанию false)

Default false
includeAnomalyDataboolean

Включать дни с аномалиями в выборку (по умолчанию false)

Default false
curl -i -X GET \
  'https://dev.api.exodrive.ai/api/v2/StatisticSummingDay?daysCount=0&includeAnomalyData=false&includeRecommendations=false&skipDaysCount=0&voucherId=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Success

Body
itemsArray of objects or null(StatisticSummingDayResponseItem)

Список скоринговых показателей по дням.

recommendationsobject(EventDensityAnalysisResult)

Результат анализа плотности событий

Response
No response example

Получить превью-скоринг за все время

Request

Возвращает скоринг за все время для конкретного ваучера, полученный быстрым методом по агрегированным данным.

Query
voucherIdstring

Служебный идентификатор ваучера

curl -i -X GET \
  'https://dev.api.exodrive.ai/api/v2/StatisticSummingGlobal?voucherId=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Success

Body
voucherIdstring or null

Служебный идентификатор ваучера

totalDaysinteger(int64)

Общее количество дней в выборке

scorenumber(double)

Итоговый скоринговый балл

totalDistanceAvgnumber(double)

Средний пробег за день

totalDistanceSumnumber(double)

Суммарный пробег за весь период

totalTimeRunningAvgnumber(double)

Среднее время в движении за день

totalTimeRunningSuminteger(int64)

Суммарное время в движении за весь период

Response
No response example

Получить выборку скоринга по месяцам

Request

Возвращает агрегированную скоринговую статистику по месяцам для конкретного ваучера

Query
voucherIdstring

Служебный идентификатор ваучера

curl -i -X GET \
  'https://dev.api.exodrive.ai/api/v2/StatisticSummingMonth/all?voucherId=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Success

Body
itemsArray of objects or null(StatisticSummingMonthResponseItem)

Список элементов месячной статистики

Response
No response example

Получить скоринг за выбранный период

Request

Возвращает агрегированные показатели скоринга и событий за указанный временной период (длиннее 1 часа) для конкретного ваучера. Опционально включает данные о крешах (IncludeCrashData=true) и рекомендации по улучшению стиля вождения (IncludeRecommendations=true).

Query
Idstring

Служебный идентификатор ваучера.

Frominteger(int64)

Начало периода в формате Unix timestamp (секунды) по UTC.

Tointeger(int64)

Конец периода в формате Unix timestamp (секунды) по UTC. Период между From и To должен быть не менее 1 часа.

IncludeCrashDataboolean

Флаг включения данных о крешах в ответ. По умолчанию false.

IncludeRecommendationsboolean

Флаг включения рекомендаций в ответ. По умолчанию false.

IncludeAnomalyDataboolean

Включать период с аномалиями в выборку (по умолчанию false). Если false и период содержит аномалии, возвращается ошибка 422.

curl -i -X GET \
  'https://dev.api.exodrive.ai/api/v2/StatisticSummingPeriod?From=0&Id=string&IncludeAnomalyData=true&IncludeCrashData=true&IncludeRecommendations=true&To=0' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Success

Body
scoringnumber or null(double)

Скоринговая оценка за выбранный период.

numBrakingnumber or null(double)

Количество событий торможения.

numAccelerationnumber or null(double)

Количество событий ускорения.

numCorneringnumber or null(double)

Количество событий поворота.

numDirectionChangenumber or null(double)

Количество событий смены направления (виляния).

numNightDrivingnumber or null(double)

Количество событий ночного вождения.

totalDistancenumber or null(double)

Общий пробег за выбранный период в километрах.

crashDataobject(CrashData)

Представляет информацию о крешах за указанный период времени.

recommendationsobject(EventDensityAnalysisResult)

Результат анализа плотности событий

hasAnomalyboolean

Флаг наличия аномалий в периоде.

Response
No response example