|
Request Parameters
Parameter
|
Description
|
Valid values
|
Note
|
Mandatory
|
till
|
End date of a period for which statistical data were requested
|
Accepted format:
YYYYMMDD
or
YYYYMMDDHHmmss
|
If the parameter is not set, then the current month statistics is returned
|
no
|
from
|
Start date of a period for which statistical data were requested
|
If the parameter is not set, then the current month statistics is returned
|
no
|
virtop
|
The number of viruses in the virus top
|
Integer values
|
The default value is 10; the parameter will be ignored if top-viruses=no
|
no
|
top-viruses
|
Virus top
|
yes | no
|
The default value is no
|
no
|
Request Example
http://192.168.1.1:9080/api/server/statistics.ds?virtop=5&top-viruses=yes
Response Documents Structure
•XML response. •JSON response. XML Response Structure
<drweb-avdesk-api api_version="4.1.3" timestamp="1392357892" server="192.168.1.1" srv_version="10.01.0.201707130" status="true">
<server-statistics period_from="1391187600" period_till="1392397199">
<infections scanned="0" total="0">
<cured>0</cured>
<moved>0</moved>
<renamed>0</renamed>
<deleted>0</deleted>
<locked>0</locked>
<errors>0</errors>
</infections>
<viruses>
<virus name="EICAR Test File (NOT a Virus!)">16</virus>
<virus name="Trojan.Spambot">24</virus>
<virus name="Trojan.Packed.370">16</virus>
</viruses>
</server-statistics>
</drweb-avdesk-api>
|
Description of XML Response Parameters
•The <server-statistics /> element contains information on the Server statistic. The <server-statistics /> element attributes:
Attribute
|
Description
|
period_from
|
Start date of a period to display statistic data
|
period_till
|
End date of a period to display statistic data
|
▫The <infections /> element contains statistics on detected objects actions. The <infections /> element attributes:
Element
|
Description
|
<cured>
|
Number of cured objects
|
<moved>
|
Number of objects that are moved to quarantine
|
<renamed>
|
Number of renamed objects
|
<deleted>
|
Number of deleted objects
|
<locked>
|
Number of blocked objects
|
<errors>
|
Number of scan errors
|
Value of these elements is the number of objects under which corresponding action is performed.
The <infections /> element attributes:
Attribute
|
Description
|
scanned
|
Total number of scanned objects
|
total
|
Total number of detected infections
|
▫The <viruses /> element contains statistics on all viruses. The <virus /> element contains information about a specific virus.
The <virus /> element attributes:
Attribute
|
Description
|
name
|
Virus name
|
count
|
Number of infected objects
|
JSON Response Structure
{ "head": {
"status": true,
"timestamp":1392357959,
"api":{
"version":40103
},
"server":{
"name":"192.168.1.1",
"version":1000201707130,
"uuid": "a509dab1-d423-4059-971a-aa3944a2c48a"
}
},
"data":{
"period_till":1392397199,
"period_from":1391187600,
"infections": {
"scanned": 0,
"infected": 0,
"cured": 0,
"moved": 0,
"deleted": 0,
"renamed": 0,
"locked": 0,
"errors": 0
} ,
"viruses": {
"EICAR Test File (NOT a Virus!)": 16 ,
"Trojan.Spambot": 24 ,
"Trojan.Packed.370": 16
}
}}
|
Description of JSON Response Parameters
The data block contains general information about the request and the blocks with the statistics requested.
The data block elements:
Field name
|
Description
|
period_from
|
End date of a period for which statistical data were requested
|
period_till
|
Start date of a period for which statistical data were requested
|
•The infections block contains statistics on detected infections. The infections elements:
Field name
|
Description
|
scanned
|
Total number of scanned files
|
infected
|
Total number of infections
|
cured
|
Number of cured oblects
|
moved
|
Number of objects that are 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 contains statistics on detected viruses. The fields names correspond to the viruses names, while the values contain the number of infected objects.
|
