WFBSS :: Summary :: Programs :: get

Views:

Last Updated: 1/22/2020 12:11:07 AM

Get summary of top N programs which violate Behavior Monitoring and Device Control within a time range

1. It returns the aggregated summary within one day if time range is not specified. 2. The largest query duration is 30 days.

Request

HTTP Request

GET /SMPI/{version}/service/wfbss/api/summary/programs

Parameters

Name	Type	Description	Validation
Optional Parameters
top	integer	Response top n computers	1 to 100. If not set, default is 100
start_time	integer	Start time of counting interval	Unix timestamp (seconds since 1970-01-01 00:00:00 UTC). end_time - start_time < 30 days
end_time	integer	End time of counting interval	Unix timestamp (seconds since 1970-01-01 00:00:00 UTC). If not set, default is now.

HTTP Request Example

Get summary of top 50 programs during last one day:
GET /SMPI/{version}/service/wfbss/api/summary/programs?top=50

Request Body

Do not supply a request body with this method.

Response

If successful, this method returns an HTTP 200 OK status code and a response body with the following structure:

{
  "summary": {
    "programs": [
      {
        name: "C:\\Program Files\\Blocked.exe",
        count: 5
      },
      {
        name: "C:\\Program Files\\Blocked_1.exe",
        count: 3
      },
      {
        name: "C:\\Program Files\\Blocked_2.exe",
        count: 1
      }
    ]
  }
}

Name	Type	Description	Length
summary.programs[].name	object	The name of the blocked file.	e.g., C:\\Program Files\\Blocked.exe
summary.programs[].count	integer	The total number of of Behavior Monitoring violations and Device Control violations