Получение статистики группы

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

Параметр	Описание	Допустимые значения	Примечание
id	Идентификатор группы	–	Обязательный параметр: да. Параметр может быть указан в запросе неограниченное количество раз для запроса информации о нескольких группах одновременно.
from	Дата начала периода, за который запрашиваются статистические данные	Параметры задаются в формате: YYYYMMDD или YYYYMMDDHHmmss	Обязательные параметры: нет. Если параметр не задан, то статистика возвращается за текущий месяц.
till	Дата окончания периода, за который запрашиваются статистические данные	Параметры задаются в формате: YYYYMMDD или YYYYMMDDHHmmss
top-viruses	Если параметр имеет значение yes, то в ответе будет приведена информация о наиболее часто встречающихся вирусах.	yes \| no	Обязательный параметр: нет. По умолчанию yes
virtop	Количество вирусов в топ вирусов	Целое положительное число	Обязательный параметр: нет. По умолчанию 10, параметр будет игнорироваться, если top-viruses=no.

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

http://192.168.1.1:9080/api/groups/statistics.ds?id=20e27d73-d21d-b211-a788-85419c46f0e6

Ниже представлены примеры ответов в формате XML и в формате JSON.

Ответ в формате XML

<drweb-es-api api_version="4.3.0" timestamp="1568207097" server="192.168.1.1" srv_version="12.00.0.201909260" status="true">
<groups-statistics total="1" period_from="1514808000" period_till="1568213999">
<group id="20e27d73-d21d-b211-a788-85419c46f0e6" name="Everyone">
<infections scanned="93297843" total="52351084">
<cured>11773944</cured>

Описание параметров ответного XML

Элемент <groups-statistics /> содержит информацию обо всех группах.

Атрибуты элемента <groups-statistics />:

Атрибут	Описание
total	Общее количество групп
period_from	Дата начала периода, за который выводятся статистические данные
period_till	Дата окончания периода, за который выводятся статистические данные

•Элемент <group /> содержит информацию о конкретной группе.

Атрибуты элемента <group />:

Атрибут	Описание
id	Идентификатор группы
name	Название группы

▫Элемент <infections /> содержит статистику по инфекциям.

Атрибуты элемента <infections />:

Атрибут	Описание
scaned	Общее количество просканированных объектов
total	Общее количество обнаруженных инфекций

Вложенные элементы элемента <infections />:

Элемент	Описание
<cured />	Количество вылеченных объектов
<moved />	Количество объектов, перемещенные в карантин
<renamed />	Количество переименованных объектов
<deleted />	Количество удаленных объектов
<locked />	Количество заблокированных объектов
<errors />	Количество ошибок при сканировании

Значением данных элементов является количество объектов, над которыми было совершенно действие, соответствующее данному элементу.

▫Элемент <viruses /> содержит статистику по всем обнаруженным вирусам.

▪Элемент <virus /> содержит информацию о конкретном вирусе. Значение элемента <virus /> — количество объектов, зараженных данным вирусом.

Атрибуты элемента <virus />:

Атрибут	Описание
name	Название вируса
stations	Количество станций, зараженных данным вирусом
originator	Код компонента, который обнаружил вирус
treatment	Код действия, примененного к вирусу и зависящего от его типа

Ответ в формате JSON

{ "head": {
"status": true,

"timestamp": 1568207129,

"api": {
"version": 40300,
"versionString": 4.3.0},

"server": {
"name": "192.168.1.1",

"version": "12.00.0.201909260",
"uuid": "7c889d36-b94a-42b8-b2c6-8c3a5500bf1e"}},

"data": {
"period_from": 1514808000,

"period_till": 1568213999,

"groups": {
"total": 1,

"list": [
{"id": "20e27d73-d21d-b211-a788-85419c46f0e6",

"infections": {
"scanned": 93297843,

"infected": 52351084,

"cured": 11773944,

"moved": 11781181,

"deleted": 11779308,

"renamed": 0,

"locked": 0,
"errors": 46174597},

"viruses": {
"11qp.d8SNO6.17481": 1,

"16aE.Il9509.17776": 1,

"fZVa.QRwL.16169": 2,

"05z9Y.5jZetG": 1,

"125F.FtE6OP7.37688": 1,

"i5S1.hI2emvT8.76WQs.54360": 2,

"0BUG5y.ekHPE.28147": 1,

"10Qp.lVZE.ELByVcwf6R.43711": 1,

"IO2V2.KpRKF.LZXzuk1ssY": 2,
"0T5q.C28VO.5360": 1},

"viruses_info": {
"11qp.d8SNO6.17481": {
"count": 1,
"originator": 37,
"stations": 1,
"treatment": 2049},

"16aE.Il9509.17776": {
"count": 1,
"originator": 37,
"stations": 1,
"treatment": 514},

"fZVa.QRwL.16169": {
"count": 2,
"originator": 37,
"stations": 1,
"treatment": 513},

"05z9Y.5jZetG": {
"count": 1,
"originator": 37,
"stations": 1,
"treatment": 2049},

"125F.FtE6OP7.37688": {
"count": 1,
"originator": 37,
"stations": 1,
"treatment": 1025},

"i5S1.hI2emvT8.76WQs.54360": {
"count": 2,
"originator": 37,
"stations": 1,
"treatment": 9},

"0BUG5y.ekHPE.28147": {
"count": 1,
"originator": 37,
"stations": 1,
"treatment": 2049},

"10Qp.lVZE.ELByVcwf6R.43711": {
"count": 1,
"originator": 37,
"stations": 1,
"treatment": 9},

"IO2V2.KpRKF.LZXzuk1ssY": {
"count": 2,
"originator": 37,
"stations": 1,
"treatment": 9},

"0T5q.C28VO.5360": {
"count": 1,
"originator": 37,
"stations": 1,
"treatment": 9}},
"name": "Everyone"}}}]}}}

Описание параметров ответного JSON

Блок data содержит общую информацию о запросе и блоки с запрошенной статистической информацией.

Элементы блока data:

Название поля	Описание
period_from	Дата окончания периода, за который запрашивались статистические данные
period_till	Дата окончания периода, за который запрашивались статистические данные

•Блок groups содержит информацию обо всех группах.

Элементы блока groups:

Название поля	Описание
total	Общее количество групп

▫Массив list содержит информацию о конкретных группах.

Элементы объектов в массиве list:

Название поля	Описание
id	Идентификатор группы
name	Название группы

▪Блок infections содержит статистику по инфекциям, обнаруженным на станциях группы.

Элементы блока infections:

Название поля	Описание
cured	Количество вылеченных объектов
deleted	Количество удаленных объектов
errors	Количество ошибок при сканировании
infected	Количество зараженных объектов
locked	Количество заблокированных объектов
moved	Количество объектов, перемещенные в карантин
renamed	Количество переименованных объектов
scanned	Общее количество просканированных файлов

▪Блок viruses содержит статистику по всем вирусам, обнаруженным на станциях группы. Названия полей соответствуют названиям обнаруженных вирусов, значение каждого поля содержит количество зараженных объектов.

▪Блок viruses_info содержит статистику по каждому из обнаруженных вирусов.

Элементы блока viruses_info:

Название поля	Описание
count	Количество объектов, зараженных данным вирусом
originator	Код компонента, который обнаружил вирус
stations	Количество станций, зараженных данным вирусом
treatment	Код действия, примененного к вирусу и зависящего от его типа