|
Request Parameters
Parameter
|
Description
|
Valid values
|
Note
|
Mandatory
|
id
|
Station identifier
|
-
|
This parameter can be defined in the request several times to request information on several stations at a time
|
yes
|
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
|
Positive integer
|
The default value is 10.
The parameter will be ignored if top-viruses=no.
|
no
|
top-viruses
|
If this parameter value is yes, then the response will contain information about the most common viruses
|
yes | no
|
The default value is yes
|
no
|
Request Example
http://192.168.1.1:9080/api/stations/statistics.ds?id=d071625c-d21d-b211-9bc4-bc02713bf843&from=1404239903&till=1404585503&virtop=5&top-viruses=yes
Response Documents Structure
•XML response. •JSON response. XML Response Structure
<drweb-avdesk-api api_version="4.1.3" timestamp="1404214881" server="192.168.1.1" srv_version="10.01.0.201707130" status="true">
<stations-statistics total="1" period_from="1404239903" period_till="1404585503">
<station id="d071625c-d21d-b211-9bc4-bc02713bf843" name="DRWEB-E32C88DAD">
<infections scanned="103081041472" total="48">
<cured>48</cured>
<moved>0</moved>
<renamed>0</renamed>
<deleted>0</deleted>
<locked>0</locked>
<errors>48</errors>
</infections>
<viruses>
<virus name="h8d47U.h0UyI.47614">2</virus>
<virus name="Id57fC.L89h.55310">2</virus>
<virus name="xRriUV.XyuMekur.56272">5</virus>
<virus name="3fvDJF.nBA048.50945">3</virus>
</viruses>
</station></stations-statistics></drweb-avdesk-api>
|
Description of XML Response Parameters
•The <stations-statistics /> element contains information about all stations. The <stations-statistics /> element attributes:
Attribute
|
Description
|
total
|
Total number of stations
|
•The <station/> element contains information about a specific station. The <station/> element attributes:
Attribute
|
Description
|
id
|
Station identifier
|
•The <infections /> element contains statistics on infections detected on the station. The <infections /> element attributes:
Attribute
|
Description
|
scanned
|
Total number of scanned files
|
total
|
Total number of infections
|
The <infections /> element elements:
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
|
Values of these elements are numbers of objects under corresponding action.
•The <viruses /> element contains statistics on all viruses detected on the station. ▫The <virus /> element contains information about a specific virus. The <virus /> element value is the number of objects infected by this virus. The <virus /> element attributes:
Attribute
|
Description
|
name
|
Virus name
|
count
|
Number of infected objects
|
JSON Response Structure
{ "head": {
"status": true,
"timestamp": 1396595270,
"api": {
"version": 40103
},
"server": {
"name": "192.168.1.1",
"version": 1000201707130,
"uuid": "7c889d36-b94a-42b8-b2c6-8c3a5500bf1e"}},
"data": {
"period_from": "20140331170000999",
"period_till": "20140404165959999",
"stations": {
"total": 1,
"list": [
{ "id": "0425f676-7468-42b4-b095-e3b57c2eb63c",
"infections": {
"scanned": 30,
"infected": 10,
"cured": 1,
"moved": 0,
"deleted": 1,
"renamed": 8,
"locked": 0,
"errors": 0},
"viruses": {
"Win32.Sector.5": 9,
"BackDoor.Haxdoor.360": 6,
"Trojan.Spambot": 18,
"Program.2Spy": 6},
"name": "TESTS-PC"
}]}}}
|
Description of JSON Response Parameters
The data block contains general information about the request and the blocks with 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 stations block contains information about all stations. The stations block elements:
Field name
|
Description
|
total
|
Total number of stations
|
▫The list array contains information about a specific station. Elements in the list array:
Field name
|
Description
|
id
|
Station identifier
|
name
|
Station name
|
▪The infections block contains statistics on infections detected on the station. The infections elements:
Field name
|
Description
|
scanned
|
Total number of scanned files
|
infected
|
Total number of infections
|
cured
|
Number of cured objects
|
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 all viruses detected on the station. The fields names correspond to the viruses names, while the values contain the number of infected objects.
| 
