Получение данных статистики
Данная фунция используется для получения информации, связанной со статистикой
Запрос информации
Для получения данных статистики внешней системе необходимо инициировать запрос к функции базы данных API_SENSOR_STATISTICS. Запрос на получение данных должен быть произведен следующим образом:
url_smartroad/api/integration/stat?login=user_login&password=user_password&project_id=project_id
Для обеспечения фильтрации данных допускается использование перечисленных в таблице дополнительных параметров запроса Функции, которые указываются после написания символа &.
Описание дополнительных параметров адреса запроса
| Параметр | Тип параметра | Описание |
|---|---|---|
| from to interval | строка строка число | Определяет промежуток времени и интервал группировки, за который производится запрос данных: - from – дата начала интервала (включительно) в формате ISO 8601 (YYYY-MM-DD HH:MM: SS) - to – дата окончания интервала (включительно) в формате ISO 8601 (YYYY-MM-DD HH:MM: SS) - interval – временной интервал группировки данных, c. Если параметр interval передан в запросе, то значение будет использовано в расчете. Например, если значение параметра interval равно 60, то будет выполнен статистический расчет для каждой минуты диапазона времени |
| interval (без from и to) | число | Временной интервал (в секундах), за который запрашиваются ретроспективные данные, начиная с момента запроса. По умолчанию 30 секунд. |
| name | строка | Имя детектора, с которого запрашиваются данные. Допускается указывать несколько имён через запятую. DEPRECATED - нежелательный параметр |
| sensor_id | строка | Уникальный идентификатор детектора. Допускается указывать несколько идентификаторов через запятую. |
| project_id | строка | Идентификатор проекта, по детекторам которого необходимо получить статистику. Обязательный параметр. |
| time_zone | строка | Часовой пояс. Формат записи – TZ identifiers. Вместо символа слеш допускается использовать знак подчёркивания «_». По умолчанию выполняется подстановка значения параметра из профиля пользователя. Пример: Europe/Moscow. |
Получение данных
При поступлении корректного запроса Система формирует ответное сообщение в формате JSON.
Пример ответного сообщения:
{
"message_id": "3e3d1708-d6dd-3742-d8c3-c179b99c758f",
"time_zone": "Europe/Moscow",
"excluded_sensors": [
"vr346hdb-fge5-ntsh-vege-dsgvg5467rfh",
"4kgk69vr-nlor-mldy-d4ib-gjypdjmldrtd",
"fwefw56v-f36v-v34l-adqc-dgg536bjk754"
],
"message_data": [
{
"sensor_id": "2ca11ec8-ef1f-4eac-89e8-18ee8b64680b",
"name": "Virtual",
"connected": false,
"lane_direction": [
0,
0
],
"direction": 1,
"data": [
{
"lanes": [
{
"lane": 0,
"volume": 0,
"class_0": 0,
"class_1": 0,
"class_2": 0,
"class_3": 0,
"class_4": 0,
"class_5": 0,
"gap_avg": 0,
"gap_sum": 0,
"speed_avg": 0,
"headway_avg": 0,
"headway_sum": 0,
"speed85_avg": 0,
"occupancy_per": "0000-00-00 00:00:00",
"occupancy_prc": 0,
"occupancy_sum": 0
},
{
"lane": 1,
"volume": 0,
"class_0": 0,
"class_1": 0,
"class_2": 0,
"class_3": 0,
"class_4": 0,
"class_5": 0,
"gap_avg": 0,
"gap_sum": 0,
"speed_avg": 0,
"headway_avg": 0,
"headway_sum": 0,
"speed85_avg": 0,
"occupancy_per": "0000-00-00 00:00:00",
"occupancy_prc": 0,
"occupancy_sum": 0
}
],
"range_end": "2024-10-02T11:37:16+03:00",
"range_start": "2024-10-02T11:36:46+03:00",
"range_value": 1
}
]
}
]
}
Описание параметров ответного сообщения
| Параметр | Тип параметра | Описание |
|---|---|---|
| message_id | строка | Идентификатор сообщения |
| time_zone | строка | Часовой пояс. Формат записи – TZ identifiers. Вместо символа слеш допускается использовать знак подчёркивания «_». По умолчанию выполняется подстановка значения параметра из профиля пользователя. Пример: Europe/Moscow. |
| message_data | массив | Вложенный массив данных |
| sensor_id | строка | Идентификатор детектора |
| excluded_sensors | строка | Идентификаторы детекторов, данные по которым получить невозможно из-за некорректн ой настройки. |
| name | строка | Имя детектора |
| connected | булево | Состояние подключения детектора, возможные значения: true / false |
| lane_direction | массив целых чисел | Направление движения по полосе: - 0 – движение к нулевому километру дороги - 1 – движение от нулевого километра дороги; - 2 – двустороннее движение. |
| direction | число | Направление установки детектора: - 0 - к нулевому километру дороги - 1 - от нулевого километра дороги |
| data | массив | Вложенный массив элементов |
| lanes | массив | Вложенный массив элементов |
| lane | число | Номер полосы движения. Полосы считаются начиная с нуля, слева направо. Для детекторов серии TMS.11 номер полосы не передается. Значение -1 означает отсутствие значения параметра |
| volume | число | Количество зафиксированных ТС |
| class_X | число | Количество зафиксированных ТС определённого класса в зависимости от длины ТС. Число классов и параметры длин ТС для каждого класса определяется в настройках Системы |
| gap_avg | число | Сре дний интервал движения за период, замер между передним бампером первого ТС и задним бампером второго ТС, с. |
| gap_sum | число | Итоговый интервал движения за период, замер между передним бампером первого ТС и задним бампером второго ТС, с. |
| speed_avg | число | Средняя скорость, км/ч |
| headway_avg | число | Средний интервал движения, замер между задним бампером первого ТС и задним бампером второго ТС, с. |
| headway_sum | число | Итоговый интервал движения, замер между задним бампером первого ТС и задним бампером второго ТС, с. |
| speed85_avg | число | Средняя скорость 85% транспортного потока, км/ч. |
| occupancy_per | строка | Загруженность полосы движения в заданный период, общее время |
| occupancy_prc | число | Загруженность полосы движения в заданный период, процент |
| occupancy_sum | число | Загруженность полосы движения в заданный период, с |
| range_end | строка | Конец интервала, в формате 2023-01-26T00:30:00+00:00 |
| range_start | строка | Начало периода отбора статистики, в формате 2023-01-26T00:30:00+00:00 |
| range_value | число | Номер интервала в диапа зоне |