|
Request Parameters
Parameter
|
Description
|
Mandatory
|
id
|
Group ID
|
yes
|
from
|
Start date of a period for which statistical data was 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 was 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/groups/infections-chart.ds?id=7ec98a70-5c83-11ea-512f-70a167e08535&from=20193105&till=20190605
|
XML and JSON response structure examples are described below.
XML Response Structure
<drweb-es-api api_version="4.3.2" timestamp="1588876162" server="192.168.1.1" srv_version="13.00.1.202310121" status="true">
<infections-chart period_from="1559314800" period_till="1559746799">
<item time="1559746799">
<infected>0</infected>
<modifications>0</modifications>
<suspicious>2</suspicious>
<activities>0</activities>
<cured>0</cured>
<moved>10</moved>
<renamed>0</renamed>
<deleted>0</deleted>
<locked>14</locked>
</item>
<!-- etc. Skipped in documentation -->
<item time="1559401199">
<infected>0</infected>
<modifications>0</modifications>
<suspicious>0</suspicious>
<activities>0</activities>
<cured>0</cured>
<moved>10</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 in a group.
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 a specific scanning in a group.
The <item /> element attribute:
Attribute
|
Description
|
time
|
Date and time of scan results transfer by Dr.Web Agent
|
▫Nested elements of the <item /> element:
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": 1588876993,
"api": {
"version": 40302,
"versionString": "4.3.2"},
"server": {
"name": "192.168.1.1",
"version": "13.00.1.202310121",
"uuid": "76b05bc0-8691-11e9-63e5-7036cecd07fa"}},
"data": {
"period_from": "1559314800",
"period_till": "1559746799",
"chart": {
"1559746799": {
"infected": 0,
"modifications": 0,
"suspicious": 2,
"activities": 0,
"cured": 0,
"moved": 10,
"deleted": 0,
"renamed": 0,
"locked": 14},
...,
"1559401199": {
"infected": 0,
"modifications": 0,
"suspicious": 0,
"activities": 0,
"cured": 0,
"moved": 10,
"deleted": 0,
"renamed": 0,
"locked": 0}}}}
|
Description of JSON Response Parameters
The data block contains performed action statistics based on all scanning runs in a group.
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
|
A block with information about actions performed as a result of every scanning in a group
|
•The chart block consists of several nested blocks.
▫Every nested block contains statistics of actions performed after a specific scanning in a group. Nested block name corresponds with a date and time when Dr.Web Agent transferred scanning results.
Nested block elements in the chart block:
Field name
|
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
|
|