|
Request Parameters
Parameter
|
Description
|
Valid values
|
Note
|
id
|
Group identifier
|
–
|
Required parameter: yes
|
from
|
Start date of a period for which statistical data were requested
|
Accepted format: YYYYMMDD or YYYYMMDDHHmmss
|
Required parameter: no.
If the parameter is not set, then the current month statistics is returned.
|
till
|
End date of a period for which statistical data were requested
|
Accepted format: YYYYMMDD or YYYYMMDDHHmmss
|
Required parameter: no.
If the parameter is not set, then the current month statistics is returned.
|
Request Example
http://192.168.1.1:9080/api/groups/infections-chart.ds?id=d071625c-d21d-b211-9bc4-bc02713bf843&from=1559314800&till=1559746799
|
XML and JSON response structure examples are described below.
XML Response
<drweb-es-api api_version="4.3.0" timestamp="1559825131" server="192.168.1.1" srv_version="12.00.0.201909260" status="true">
<infections-chart total="1" period_from="1559314800" period_till="1559746799">
<item time="1559746799">
<infected>0</infected>
<cured>0</cured>
<moved>0</moved>
<renamed>0</renamed>
<deleted>0</deleted>
<locked>14</locked>
</item>
<item time="1559401199">
<infected>0</infected>
<cured>0</cured>
<moved>0</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 information on all scan launches for a group.
The <infections-chart /> element attributes:
Attribute
|
Description
|
total
|
Total number of stations
|
period_from
|
Start date of a period for which statistical data were requested
|
period_till
|
End date of a period for which statistical data were requested
|
•The <item /> element contains information on actions performed after a specific station scan. <item /> element attribute:
Attribute
|
Description
|
time
|
Date and time of scan results transfer by Dr.Web Agent
|
The <item /> element elements:
Element
|
Description
|
<infected />
|
Number of infected objects
|
<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
|
Values of these elements are numbers of objects under corresponding action.
JSON Response
{ "head": {
"status": true,
"timestamp": 1559737436,
"api": {
"version": 40300,
"versionString": 4.3.0},
"server": {
"name": "192.168.1.1",
"version": "12.00.0.201909260",
"uuid": "76b05bc0-8691-11e9-63e5-7036cecd07fa"}},
"data": {
"period_from": "1559314800",
"period_till": "1559746799",
"chart": {
"1559746799": {
"infected": 0,
"cured": 0,
"moved": 10,
"deleted": 0,
"renamed": 0,
"locked": 14},
"1559401199": {
"infected": 0,
"cured": 0,
"moved": 10,
"deleted": 0,
"renamed": 0,
"locked": 0}}}}
|
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
|
Start date of a period for which statistical data were requested
|
period_till
|
End date of a period for which statistical data were requested
|
•The chart block contains information units on all scan launch results for a group. Elements in the chart block:
Field name
|
Description
|
Date and time of scan results transfer by Dr.Web Agent
|
Statistics on actions performed after a specific station scan:
•infected—number of infected objects, •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 |
|