|
Request Parameters
Parameter
|
Description
|
Valid values
|
Note
|
Mandatory
|
id
|
Tariff group identifier
|
-
|
This parameter can be defined in the request several times to request information on several groups at a time
|
yes
|
till
|
End date of a period for which statistical data is 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 is 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 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/groups/statistics.ds?id=20e27d73-d21d-b211-a788-85419c46f0e6
Response Documents Structure
•XML response. •JSON response. XML Response Structure
<drweb-avdesk-api api_version="4.1.3" timestamp="1396340556" server="192.168.1.1" srv_version="10.01.0.201707130" status="true">
<groups-statistics total="1" period_from="1396285200" period_till="1396371599">
<group id="20e27d73-d21d-b211-a788-85419c46f0e6" name="Everyone">
<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="Win32.Sector.5">4</virus>
<virus name="BackDoor.Haxdoor.360">2</virus>
<virus name="Trojan.Spambot">6</virus>
<virus name="BackDoor.Tdss.based.7">2</virus>
<virus name="BackDoor.Tdss.77">2</virus>
<virus name="Trojan.PWS.GoldSpy">4</virus>
</group>
</groups-statistics>
</drweb-avdesk-api>
|
Description of XML Response Parameters
•The <groups-statistics /> element contains information about all groups. The <groups-statistics /> element attributes:
Attribute
|
Description
|
total
|
Total number of groups
|
period_from
|
Start date of a period for which statistical data received
|
period_till
|
End date of a period for which statistical data received
|
▫The <group /> element contains information about a specific group. The <group /> element attributes:
Attribute
|
Description
|
id
|
Group identifier
|
name
|
Group name
|
▫The <infections /> element contains statistics on infections. The <infections /> element attributes:
Attribute
|
Description
|
scaned
|
Total number of scanned objects
|
total
|
Total number of detected infections
|
from
|
Time of scan start
|
till
|
Time of scan finish
|
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
|
Value of these elements is the number of objects under which corresponding action is performed.
▫The <viruses /> element contains statistics on detected viruses. ▪The <virus /> element contains information about a specific virus. The <virus /> element attributes:
Attribute
|
Description
|
name
|
Virus name
|
The <virus /> element value is a number of objects infected by this virus.
JSON Response Structure
{ "head": {
"status": true,
"timestamp": 1396340637,
"api": {
"version": 40103
},
"server": {
"name": "192.168.1.1",
"version": 1000201707130,
"uuid": "7c889d36-b94a-42b8-b2c6-8c3a5500bf1e"
}
},
"data": {
"period_from": 1396285200,
"period_till": 1396371599,
"groups": {
"total": 1,
"list": [
{
"id": "20e27d73-d21d-b211-a788-85419c46f0e6",
"infections": {
"scanned": 0,
"infected": 0,
"cured": 0,
"moved": 0,
"deleted": 0,
"renamed": 0,
"locked": 0,
"errors": 0
},
"viruses": {
"Win32.Sector.5": 4,
"BackDoor.Haxdoor.360": 2,
"Trojan.Spambot": 6,
"BackDoor.Tdss.based.7": 2,
"BackDoor.Tdss.77": 2
},
"name": "Everyone"
}
]
}
}
}
|
Description of JSON Response Parameters
The data block contains general information on 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 groups block contains information about all groups. The groups block elements:
Field name
|
Description
|
total
|
Total number of groups
|
▫The list array contains information about a specific group. Elements in the list array:
Field name
|
Description
|
id
|
Group identifier
|
name
|
Group name
|
•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.
| 
