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

Valid values: yes | no. By default: yes.

no

virtop

Number of viruses in virus 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.0" timestamp="1587653647" server="192.168.1.1" srv_version="12.00.0.201909260" status="true">
  <stations-statistics total="1" period_from="1585688400" period_till="1587675599">
     <station id="1002" name="WIN7-PRO-X64-RU">
        <infections scanned="2697" total="12">
           <modifications>0</modifications>

           <suspicious>2</suspicious>

           <activities>0</activities>

           <cured>1</cured>

           <moved>5</moved>

           <renamed>0</renamed>

           <deleted>0</deleted>

           <locked>0</locked>

           <errors>0</errors>
        </infections>

        <viruses>
           <virus name="Adware.Dudu" originator="57" treatment="1049605">1</virus>

           <virus name="Dialer.Adultparty" originator="57" treatment="1049605">1</virus>

           <virus name="EICAR Test File (NOT a Virus!)" originator="57" treatment="1049605">1</virus>

           <virus name="HLLP.Setart.19919" originator="57" treatment="1049605">1</virus>

           <virus name="Joke.EjectCd" originator="57" treatment="1049605">1</virus>
        </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 virus 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 viruses.

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

The <virus /> element attributes:

Attribute

Description

name

Virus name

originator

Code of a component that found a virus

treatment

Code of action applied to a virus. Depends on virus type.

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

 

JSON Response Structure

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

    "timestamp": 1587653710,

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

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

      "version": "12.00.0.201909260",
      "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 viruses. Fields names correspond to detected viruses names, while value of each field contains number of infected objects.

viruses_info

Block contains statistics on each detected virus

name

Station name

The infections block 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 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 virus

originator

Code of a component that found a virus

stations

Number of stations infected by a specific virus

treatment

Code of action applied to a virus. Depends on virus type.