|
Request Parameters
Parameter
|
Description
|
Mandatory
|
id
|
Station ID
|
yes
|
from
|
Start date of a period for which statistical data is requested.
Specified in the format: YYYYMMDD or YYYYMMDDhhmmss.
If not set, then the current month statistics is returned.
|
no
|
till
|
End date of a period for which statistical data is requested.
Specified in the format: YYYYMMDD or YYYYMMDDhhmmss.
If not set, then the current month statistics is returned.
|
no
|
Request Example
https://192.168.1.1:9081/api/stations/infections-chart.ds?id=1002
|
XML and JSON response structure examples are described below.
XML Response Structure
<drweb-es-api api_version="4.3.2" timestamp="1587673642" server="192.168.1.1" srv_version="13.00.1.202310121" status="true">
<infections-chart period_from="1587673642" period_till="1587675599">
<item time="1587675599">
<infected>12</infected>
<modifications>0</modifications>
<suspicious>2</suspicious>
<activities>0</activities>
<cured>1</cured>
<moved>5</moved>
<renamed>0</renamed>
<deleted>0</deleted>
<locked>0</locked>
</item>
<!-- etc. Skipped in documentation -->
<item time="1585861199">
<infected>0</infected>
<modifications>0</modifications>
<suspicious>0</suspicious>
<cured>0</cured>
<moved>0</moved>
<renamed>0</renamed>
<deleted>0</deleted>
<locked>0</locked>
</item>
</infections-chart>
</drweb-es-api>
|
Description of XML Response Parameters
The <infections-chart /> element contains performed action statistics based on all scanning runs on a station.
The <infections-chart /> element attributes:
Attribute
|
Description
|
period_from
|
Start date of a period for which statistical data was requested
|
period_till
|
End date of a period for which statistical data was requested
|
•The <item /> element contains information about actions performed as a result of specific scanning made on a station.
The <item /> element attribute:
Attribute
|
Description
|
time
|
Date and time of scan results transfer by Dr.Web Agent
|
▫The <item /> element elements:
Element
|
Description
|
<infected />
|
Number of malicious objects
|
<modifications />
|
Number of objects infected with threat modifications
|
<suspicious />
|
Number of suspicious objects
|
<activities />
|
Number of malicious actions
|
<cured />
|
Number of cured objects
|
<moved />
|
Number of objects moved to Quarantine
|
<renamed />
|
Number of renamed objects
|
<deleted />
|
Number of deleted objects
|
<locked />
|
Number of blocked objects
|
JSON Response Structure
{ "head": {
"status": true,
"timestamp": 1587673607,
"api": {
"version": 40302,
"versionString": "4.3.2"},
"server": {
"name": "192.168.1.1",
"version": "13.00.1.202310121",
"uuid": "6d8f5aa0-850a-11ea-4c3c-c8efa441e4dd"}},
"data": {
"period_from": 1585688400,
"period_till": 1587675599,
"chart": {
"1587675599": {
"infected": 12,
"modifications": 0,
"suspicious": 2,
"activities": 0,
"cured": 1,
"moved": 5,
"deleted": 0,
"renamed": 0,
"locked": 0},
...,
"1585861199": {
"infected": 0,
"modifications": 0,
"suspicious": 0,
"activities": 0,
"cured": 0,
"moved": 0,
"deleted": 0,
"renamed": 0,
"locked": 0}}}}
|
Description of JSON Response Parameters
The data block contains performed action statistics based on all scanning runs on a station.
The data block elements:
Field name
|
Description
|
period_from
|
Start date of a period for which statistical data was requested
|
period_till
|
End date of a period for which statistical data was requested
|
chart
|
Block with information about actions performed as a result of every scanning on a station
|
•The chart block consists of several nested blocks.
▫Every nested block contains statistics of actions performed after a specific scanning on a station. Nested block name corresponds with the date and time when Dr.Web Agent transferred the scanning results.
Nested block elements in the chart block:
Field name
|
Description
|
infected
|
Number of malicious objects
|
modifications
|
Number of objects infected with treat modifications
|
suspicious
|
Number of suspicious objects
|
activities
|
Number of malicious actions
|
cured
|
Number of cured objects
|
moved
|
Number of objects moved to Quarantine
|
renamed
|
Number of renamed objects
|
deleted
|
Number of deleted objects
|
locked
|
Number of blocked objects
|
|