Get Station Statistics

Request Parameters

Parameter	Description	Mandatory
id	Station ID. This parameter can be defined in the request several times to request information on multiple stations at a time.	yes
from	Start date of a period for which statistical data is requested. Is provided in YYYYMMDD or YYYYMMDDhhmmss formats. If parameter is not set, then current month statistics is returned.	no
till	End date of a period for which statistical data is requested Is provided in YYYYMMDD or YYYYMMDDhhmmss formats. If parameter is not set, then current month statistics is returned.	no
top-viruses	If parameter value is yes, then the response will contain information about the most common threats. Valid values: yes \| no. By default: yes.	no
virtop	Number of treats in treats top. Valid values: positive integer. By default: 10. Parameter will be ignored if top-viruses=no.	no

Request Example

https://192.168.1.1:9081/api/stations/statistics.ds?id=1002&virtop=5&top-viruses=yes

XML and JSON response structure examples are described below.

XML Response Structure

<drweb-es-api api_version="4.3.2" timestamp="1587653647" server="192.168.1.1" srv_version="13.00.1.202310121" status="true">

<stations-statistics total="1" period_from="1585688400" period_till="1587675599">

</infections>

</viruses>

</station>

</stations-statistics>

</drweb-es-api>

Description of XML Response Parameters

The <stations-statistics /> element contains statistics of all stations specified in a request.

The <stations-statistics /> element attributes:

Attribute	Description
total	Total number of stations in a response
period_from	Start date of a period for which statistical data were requested
period_till	End date of a period for which statistical data is requested

•The <station /> element contains information about a specific station.

The <station /> element attributes:

Attribute	Description
id	Station ID
name	Station name

▫The <infections /> element contains statistics on detected infections.

The <infections /> element attributes:

Attribute	Description
scanned	Total number of scanned files
total	Total number of infections

▪The <infections /> element elements:

Element	Description
<modifications />	Number of objects infected with treat modifications
<suspicious />	Number of suspicious objects
<activities />	Number of malicious actions
<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
<errors />	Number of scan errors

▫The <viruses /> element contains statistics on detected threats.

▪The <virus /> element contains information about a specific threat.

The <virus /> element attributes:

Attribute	Description
name	Threat name
originator	Code of a component that found a threat
treatment	Code of action applied to a threat. Depends on threat type.

The <virus /> element value is the number of objects infected by this threat.

JSON Response Structure

{ "head": {

"status": true,

"timestamp": 1587653710,

"api": {

"version": 40302,

"versionString": "4.3.2"},

"server": {

"name": "192.168.1.1",

"version": "13.00.1.202310121",

"uuid": "6d8f5aa0-850a-11ea-4c3c-c8efa441e4dd"}},

"data": {

"period_from": 1585688400,

"period_till": 1587675599,

"stations": {

"total": 1,

"list": [

{"id": "1002",

"infections": {

"scanned": 2697,

"infected": 12,

"modifications": 0,

"suspicious": 2,

"activities": 0,

"cured": 1,

"moved": 5,

"deleted": 0,

"renamed": 0,

"locked": 0,

"errors": 0},

"viruses": {

"Adware.Dudu": 1,

"Dialer.Adultparty": 1,

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

"HLLP.Setart.19919": 1,

"Joke.EjectCd": 1},

"viruses_info": {

"Adware.Dudu": {

"count": 1,

"originator": 57,

"stations": 1,

"treatment": 1049605},

"Dialer.Adultparty": {

"count": 1,

"originator": 57,

"stations": 1,

"treatment": 1049605},

"EICAR Test File (NOT a Virus!)": {

"count": 1,

"originator": 57,

"stations": 1,

"treatment": 1049605},

"HLLP.Setart.19919": {

"count": 1,

"originator": 57,

"stations": 1,

"treatment": 1049605},

"Joke.EjectCd": {

"count": 1,

"originator": 57,

"stations": 1,

"treatment": 1049605}},

"name": "WIN7-PRO-X64-RU"}]}}}

Description of JSON Response Parameters

The data block contains statistics of all stations specified in a request.

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 was requested
stations	Block contains statistics of all stations specified in a request

•The stations block elements:

Field name	Description
total	Total number of stations in a response
list	Array with statistics for each station

▫Each element of the list array contains information on a specific station.

Elements in the list array:

Field name	Description
id	Station ID
infections	Block contains statistics on all detected infections
viruses	Block with statistics on all detected threats. Fields names correspond to detected threat names, while value of each field contains number of malicious objects.
viruses_info	Block contains statistics on each detected threat
name	Station name

▪The infections block elements:

Field name	Description
scanned	Total number of scanned files
infected	Number of malicious objects
modifications	Number of objects infected with threat modifications
suspicious	Number of suspicious objects
activities	Number of malicious actions
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
errors	Number of scan errors

▪The viruses_info block elements:

Field name	Description
count	Number of objects infected by this threat
originator	Code of a component that found a threat
stations	Number of stations infected by a specific threat
treatment	Code of action applied to a threat. Depends on threat type.