Get Station Statistics

Request Parameters

Parameter

Description

Valid values

Note

id

Station identifier

Required parameter: yes.

This parameter can be defined in the request several times to request information on several stations at a time.

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

If this parameter value is yes, then the response will contain information about the most common viruses.

yes | no

Required parameter: no.

The default value is yes

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/stations/statistics.ds?id=146c3a70-b9e4-11e9-6bb5-60b9afbd1dcd&from=1514808000&till=1568213999&virtop=5&top-viruses=yes

XML and JSON response structure examples are described below.

 

XML Response Structure

<drweb-es-api api_version="4.3.0" timestamp="1568207097" server="192.168.1.1" srv_version="12.00.0.201909260" status="true">
  <stations-statistics total="1" period_from="1514808000" period_till="1568213999">
     <station id="146c3a70-b9e4-11e9-6bb5-60b9afbd1dcd" name="T-PC">
        <infections scanned="93297843" total="52351084">
           <cured>11773944</cured>

           <moved>11781181</moved>

           <renamed>0</renamed>

           <deleted>11779308</deleted>

           <locked>0</locked>

           <errors>46174597</errors>
        </infections>

        <viruses>
           <virus name="IO2V2.KpRKF.LZXzuk1ssY" originator=37" treatment=9">2</virus

           <virus name="125F.FtE6OP7.37688" originator=37" treatment=1025">1</virus>

           <virus name="16aE.Il9509.17776" originator=37" treatment=514">1</virus>

           <virus name="05z9Y.5jZetG" originator=37" treatment=2049">1</virus>

           <virus name="0T5q.C28VO.5360" originator=37" treatment=9">1</virus>

           <virus name="11qp.d8SNO6.17481" originator=37" treatment=2049">1</virus>

           <virus name="0BUG5y.ekHPE.28147" originator=37" treatment=2049">1</virus>

           <virus name="10Qp.lVZE.ELByVcwf6R.43711" originator=37" treatment=9">1</virus>

           <virus name="i5S1.hI2emvT8.76WQs.54360" originator=37" treatment=9">2</virus>

           <virus name="fZVa.QRwL.16169" originator=37" treatment=513">2</virus>
        </viruses>
     </station>
  </stations-statistics>
</drweb-es-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

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 <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 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

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": 1568207129,

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

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

      "version": "12.00.0.201909260",
      "uuid": "677a4aa0-b1dc-11e9-7e50-fcf926e3976b"}},

"data": {
    "period_from": "1514808000",

    "period_till": "1568213999",

    "stations": {
      "total": 1,

      "list": [
          {"id": "146c3a70-b9e4-11e9-6bb5-60b9afbd1dcd",

          "infections": {
              "scanned": 93297843,

              "infected": 52351084,

              "cured": 11773944,

              "moved": 11781181,

              "deleted": 11779308,

              "renamed": 0,

              "locked": 0,
              "errors": 46174597},

          "viruses": {
              "11qp.d8SNO6.17481": 1,

              "16aE.Il9509.17776": 1,

              "fZVa.QRwL.16169": 2,

              "05z9Y.5jZetG": 1,

              "125F.FtE6OP7.37688": 1,
              "i5S1.hI2emvT8.76WQs.54360": 2,
              "0BUG5y.ekHPE.28147": 1,
              "10Qp.lVZE.ELByVcwf6R.43711": 1,
              "IO2V2.KpRKF.LZXzuk1ssY": 2,
              "0T5q.C28VO.5360": 1},

          "viruses_info": {
              "11qp.d8SNO6.17481": {
                "count": 1,
                "originator": 37,
                "stations": 1,
                "treatment": 2049},

              "16aE.Il9509.17776": {
                "count": 1,
                "originator": 37,
                "stations": 1,
                "treatment": 514},

              "fZVa.QRwL.16169": {
                "count": 2,
                "originator": 37,
                "stations": 1,
                "treatment": 513},

              "05z9Y.5jZetG": {
                "count": 1,
                "originator": 37,
                "stations": 1,
                "treatment": 2049},

              "125F.FtE6OP7.37688": {
                "count": 1,
                "originator": 37,
                "stations": 1,
                "treatment": 1025},

              "i5S1.hI2emvT8.76WQs.54360": {
                "count": 2,
                "originator": 37,
                "stations": 1,
                "treatment": 9},

              "0BUG5y.ekHPE.28147": {
                "count": 1,
                "originator": 37,
                "stations": 1,
                "treatment": 2049},

              "10Qp.lVZE.ELByVcwf6R.43711": {
                "count": 1,
                "originator": 37,
                "stations": 1,
                "treatment": 9},

              "IO2V2.KpRKF.LZXzuk1ssY": {
                "count": 2,
                "originator": 37,
                "stations": 1,
                "treatment": 9},

              "0T5q.C28VO.5360": {
                "count": 1,
                "originator": 37,
                "stations": 1,
                "treatment": 9}},

          "name": "T-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

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 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 specific stations.

Elements in the list array:

Field name

Description

id

Station ID

name

Station name

The infections block contains statistics on infections detected on the station.

The infections elements:

Field name

Description

cured

Number of cured objects

deleted

Number of deleted objects

errors

Number of scan errors

infected

Number of infected objects

locked

Number of blocked objects

moved

Number of objects that are moved to quarantine

renamed

Number of renamed objects

scanned

Total number of scanned files

The viruses block contains statistics on all viruses detected on the stations with the identifiers specified in the request. 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.

The viruses_info block elements:

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