|
Request Parameters
Parameter
|
Description
|
Mandatory
|
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
|
top-viruses
|
Threat top.
Valid values: yes | no. By default: yes.
|
no
|
virtop
|
Number of threats in the threat top.
Valid values: positive integer. By default: 10.
This parameter will be ignored if top-viruses=no.
|
no
|
Request Example
https://192.168.1.1:9081/api/server/statistics.ds?virtop=100&top-viruses=yes
|
XML and JSON response structure examples are described below.
XML Response Structure
<drweb-es-api api_version="4.3.2" timestamp="1587315430" server="192.168.1.1" srv_version="13.00.1.202310121" status="true">
<server-statistics period_from="1585688400" period_till="1587329999">
<infections scanned="7864" total="2">
<modifications>0</modifications>
<suspicious>0</suspicious>
<activities>2</activities>
<cured>0</cured>
<moved>0</moved>
<renamed>0</renamed>
<deleted>2</deleted>
<locked>0</locked>
<errors>2767</errors>
</infections>
<viruses>
<virus name="EICAR Test File (NOT a Virus!)" stations="1" originator=115" treatment=513">2</virus>
</viruses>
</server-statistics>
<stations></stations>
</drweb-es-api>
|
Description of XML Response Parameters
The <server-statistics /> element contains information about the Dr.Web Server statistics.
The <server-statistics /> element attributes:
Attribute
|
Description
|
period_from
|
Start date of a period the statistics is displayed for
|
period_till
|
End date of a period the statistics is displayed for
|
•The <infections /> element contains statistics about actions applied to detected objects.
The <infections /> element attributes:
Attribute
|
Description
|
scanned
|
Total number of scanned objects
|
total
|
Total number of detected infections
|
▫Nested elements of the <infections /> element:
Element
|
Description
|
<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
|
<errors />
|
Number of scan errors
|
Values of these elements are numbers of objects to which an action was applied corresponding with a specific element.
•The <viruses /> element contains statistics on all detected threats.
▫The <virus /> element contains information about a specific threat.
The <virus /> element attributes:
Attribute
|
Description
|
name
|
Threat name
|
stations
|
Number of stations infected with this threat
|
originator
|
Code of a component that found a threat
|
treatment
|
Code of an action applied to a malicious object depending on threat type
|
The <virus /> element value is the number of objects infected with this threat.
JSON Response Structure
{ "head": {
"status": true,
"timestamp": 1587315538,
"api": {
"version": 40302,
"versionString": "4.3.2"},
"server": {
"name": "192.168.1.1",
"version": "13.00.1.202310121",
"uuid": "uuid": "b35d999d-9212-481d-af8c-8551c4113383"}},
"data": {
"period_till": 1587329999,
"period_from": 1585688400,
"infections": {
"scanned": 7864,
"infected": 2,
"modifications": 0,
"suspicious": 0,
"activities": 2,
"cured": 0,
"moved": 0,
"deleted": 2,
"renamed": 0,
"locked": 0,
"errors": 2767},
"viruses": {
"EICAR Test File (NOT a Virus!)": 2},
"viruses_info": {
"EICAR Test File (NOT a Virus!)": {
"count": 2,
"originator": 115,
"stations": 1,
"treatment": 513}}}}
|
Description of JSON Response Parameters
The data block contains information about the Dr.Web Server statistics.
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
|
infections
|
Block containing statistics on actions applied to detected objects
|
viruses
|
Block with summary statistics about all detected threats
|
viruses_info
|
Block containing statistics about every detected threat
|
•The infections block elements:
Field name
|
Description
|
scanned
|
Total number of scanned files
|
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
|
deleted
|
Number of deleted objects
|
renamed
|
Number of renamed objects
|
locked
|
Number of blocked objects
|
errors
|
Number of scan errors
|
•The viruses block elements:
Field name
|
Description
|
Detected virus name
|
Number of malicious objects
|
•The viruses_info block consists of nested blocks.
▫Every nested block contains statistics about each detected threat. Nested block name corresponds with a name of detected threat.
Nested block elements in the viruses_info block:
Field name
|
Description
|
count
|
Number of objects infected with this threat
|
originator
|
Code of a component that found a threat
|
stations
|
Number of stations infected with this threat
|
treatment
|
Code of an action applied to a malicious object depending on threat type
|
|