Get Group Statistics

Request Parameters

Parameter

Description

Mandatory

id

Group ID.

This parameter can be repeated any number of times per request to request information about multiple groups at a time.

yes

from

Start date of a period for which statistical data was requested.

Specified in the format: YYYYMMDD or YYYYMMDDhhmmss.
If not set, then the current month statistics is returned.

no

till

End date of a period for which statistical data was requested.

Specified in the format: YYYYMMDD or YYYYMMDDhhmmss.
If not set, then the current month statistics is returned.

no

top-viruses

If this parameter’s 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 threats in the threat top.

Valid values: positive integer. By default: 10.
This parameter will be ignored if top-viruses=no.

no

 

Request Example

https://192.168.1.1:9081/api/groups/statistics.ds?id=20e27d73-d21d-b211-a788-85419c46f0e6

XML and JSON response structure examples are described below.

 

XML Response Structure

<drweb-es-api api_version="4.3.2" timestamp="1588879372" server="192.168.1.1" srv_version="13.00.1.202310121" status="true">
  <groups-statistics total="1" period_from="1588280400" period_till="1588885199">
     <group id="20e27d73-d21d-b211-a788-85419c46f0e6" name="Everyone">
        <infections scanned="93297843" total="52351084">
           <modifications>0</modifications>

           <suspicious>2</suspicious>

           <activities>0</activities>

           <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" stations="1" originator=37" treatment=9">2</virus>

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

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

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

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

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

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

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

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

           <virus name="fZVa.QRwL.16169" stations="1" originator=37" treatment=513">2</virus>
        </viruses>
     </group>
  </groups-statistics>
</drweb-es-api>

 

Description of XML Response Parameters

The <groups-statistics /> element contains statistics for stations in groups specified in the request.

The <groups-statistics /> element attributes:

Attribute

Description

total

Total number of groups in a response

period_from

Start date of a period for displayed statistical data

period_till

End date of a period for displayed statistical data

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

The <group /> element attributes:

Attribute

Description

id

Group ID

name

Group name

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

The <infections /> element attributes:

Attribute

Description

scanned

Total number of scanned objects

total

Total number of detected infections

▪Nested elements of the <infections /> element:

Element

Description

<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

<renamed />

Number of renamed objects

<deleted />

Number of deleted objects

<locked />

Number of blocked objects

<errors />

Number of scanning 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

stations

Number of stations infected with this threat

originator

Code of a component that found a threat

treatment

Code of an action applied to a malicious object depending on threat type

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

 

JSON Response Structure

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

    "timestamp": 1588883331,

    "api": {
      "version": 40302,
      "versionString": "4.3.2"},

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

      "version": "13.00.1.202310121",
      "uuid": "b35d999d-9212-481d-af8c-8551c4113383"}},

"data": {
    "period_from": 1588280400,

    "period_till": 1588885199,

    "groups": {
      "total": 1,

      "list": [
          {"id": "20e27d73-d21d-b211-a788-85419c46f0e6",

          "infections": {
              "scanned": 93297843,

              "infected": 52351084,

              "modifications": 0,

              "suspicious": 2,

              "activities": 0,

              "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": "Everyone"}}}]}}}

 

Description of JSON Response Parameters

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

The data block elements:

Field name

Description

period_from

Start date of a period for which statistical data was requested

period_till

End date of a period for which statistical data was requested

groups

Block containing statistics of stations in the specified groups

•The groups block contains information about all specified groups.

The groups block elements:

Field name

Description

total

Total number of groups

list

Array with information about every group

▫Every object in the list array contains information about a specific group.

Elements in the list array:

Field name

Description

id

Group ID

infections

Block containing statistics about detected infections

viruses

Block containing statistics about detected threats

viruses_info

Block containing statistics about every detected threat

name

Group name

▪The infections block elements:

Field name

Description

modifications

Number of objects infected with threat modifications

suspicious

Number of suspicious objects

activities

Number of malicious actions

cured

Number of cured objects

deleted

Number of deleted objects

errors

Number of scanning errors

infected

Number of malicious objects

locked

Number of blocked objects

moved

Number of objects moved to Quarantine

renamed

Number of renamed objects

scanned

Total number of scanned files

▪The viruses block elements:

Field name

Description

Detected threat name

Number of objects infected with this threat

▪The viruses_info block elements:

Field name

Description

count

Number of objects infected with this threat

originator

Code of a component that found a threat

stations

Number of stations infected with this threat

treatment

Code of an action applied to a malicious object depending on threat type