Get Server statistics on detected threats

Request Parameters

Parameter	Description	Valid values	Note
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.
top-viruses	Virus top	yes \| no	Required parameter: no. The default value is no
virtop	The number of viruses in the virus top	Positive integer	Required parameter: no. The default value is 10; the parameter will be ignored if top-viruses=no.

Request Example

http://192.168.1.1:9080/api/server/statistics.ds?virtop=100&top-viruses=yes&from=1567285200&till=1569877199

XML and JSON response structure examples are described below.

XML Response Structure

<drweb-es-api api_version="4.3.0" timestamp="1569835428" server="192.168.1.1" srv_version="12.00.0.201909260" status="true">
<server-statistics period_from="1567285200" period_till="1569877199">
<infections scanned="72" total="16">

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:

Attribute	Description
scanned	Total number of scanned objects
total	Total number of detected infections

The <infections /> element elements:

Element	Description
<modifications />	Number of objects infected with virus modifications
<suspicious />	Number of suspicious objects
<activities />	Number of malicious actions
<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 all detected viruses.

▫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
stations	Number of stations infected by a specific virus
originator	Code of a component that found a virus
treatment	Code of an action performed towards an infected object

JSON Response Structure

{ "head": {
"status": true,

"timestamp": 1569834553,

"api": {
"version": 40300,
"versionString": 4.3.0},

"server": {
"name": "192.168.1.1",

"version": "12.00.0.201909260",
"uuid": "99e24f80-e35d-11e9-64e2-b45638e9b982"}},

"data": {
"period_till": 1569877199,

"period_from": 1567285200,

"infections": {
"scanned": 72,

"infected": 16,

"modifications": 0,

"suspicious": 1,

"activities": 0,

"cured": 0,

"moved": 7,

"deleted": 0,

"renamed": 0,

"locked": 0,
"errors": 7},

"viruses": {
"Dialer.Adultparty": 1,

"HLLP.Setart.19919": 1,

"Adware.Dudu": 1,

"Program.2Spy": 2,

"EICAR Test File (NOT a Virus!)": 1},

"viruses_info": {
"Dialer.Adultparty": {
"count": 1,
"originator": 57,
"stations": 1,
"treatment": 1049605},

"HLLP.Setart.19919": {
"count": 1,
"originator": 57,
"stations": 1,
"treatment": 9},

"Adware.Dudu": {
"count": 1,
"originator": 57,
"stations": 1,
"treatment": 1049605},

"Program.2Spy": {
"count": 2,
"originator": 4,
"stations": 1,
"treatment": 1},

"EICAR Test File (NOT a Virus!)": {
"count": 1,
"originator": 57,
"stations": 1,
"treatment": 1049605}}}}

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	End date of a period for which statistical data were requested

•The infections block contains statistics on detected objects actions.

The infections elements:

Field name	Description
scanned	Total number of scanned files
infected	Number of infected objects
modifications	Number of objects infected with virus modifications
suspicious	Number of suspicious objects
activities	Number of malicious actions
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 detected viruses. The fields names correspond to the viruses names, while the values contain the number of infected objects.

•The viruses_info block contains statistics on each detected virus.

▫Elements of a block with the detected virus name:

Field name	Description
count	Number of objects infected by this virus
originator	Code of a component that found a virus
stations	Number of stations infected by a specific virus
treatment	Code of an action performed towards an infected object