Last Updated: 1/22/2020 12:11:04 AM
Get summary of given customers 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/customers/summary
Parameters
Name |
Type |
Description |
Validation |
|---|---|---|---|
|
Required Parameters |
|||
cids |
A list of customer ID separated by comma. |
At least one customer IDs must be specified, and no more than 10. |
|
|
Optional Parameters |
|||
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. |
fields |
string |
A list of summay types separated by comma. |
Valid values are: computers, programs, malwares, url_categories, and stats. If not set, return all fields. |
page |
integer |
Page number |
1 to max. If not set, default is 1 |
limit |
integer |
Number of records per page |
1 to 100. If not set, default is 25 |
HTTP Request Example
Get summary from given customers from one day ago till now :
GET /SMPI/{version}/service/wfbss/api/customers/summary?cids=640FE47F-5118-4D79-8221-A35D0DE2EE2C,549390C2-61B3-417E-B1F0-8955A63C08F3
Get summary from given customers within the time range :
GET /SMPI/{version}/service/wfbss/api/customers/summary?cids=640FE47F-5118-4D79-8221-A35D0DE2EE2C,549390C2-61B3-417E-B1F0-8955A63C08F3&start_time=1370315252&end_time=1370747252
Request Body
Do not supply a request body with this method.
Response
Response
If successful, this method returns an HTTP 200 OK status code and a response body with the following structure:
{
"paging": {
"total": 1,
"limit": 10,
"page": 1
},
"customers": [
{
"id": "AD38F82D-51A1-46FD-B167-E0D0FF31BE83",
"summary": {
"url_categories": [
{
"count": 40,
"id": 69
}
],
"stats": {
"virus": {
"deleted": 36,
"quarantined": 33,
"renamed": 39,
"passed": 30,
"cleaned": 14,
"uncleanable": 148
},
"spyware": {
"noncleaned": 154,
"unsafe": 38,
"reboot": 59,
"cleaned": 49
}
},
"computers": [
{
"wtp": 2,
"name": "Computer_d2f871c7641fd747881e88b87745ac8b",
"cid": "AD38F82D-51A1-46FD-B167-E0D0FF31BE83",
"spyware": 2,
"behavior_monitoring": 2,
"url_filtering": 1,
"virus": 3,
"network_virus": 0,
"type": 1,
"id": "d2f871c7641fd747881e88b87745ac8b"
}
],
"malwares": [
{
"count": 1,
"type": 2,
"name": "Dialer_CashDialer"
},
{
"count": 1,
"type": 3,
"name": "VirusLocker"
},
{
"count": 1,
"type": 3,
"name": "Xmailer"
}
],
"programs": [
{
"count": 1,
"id": 50,
"name": {
"target_1": 1
}
},
{
"count": 1,
"id": 165,
"name": {
"target_0": 1
}
},
{
"count": 1,
"id": 85,
"name": {
"target_2": 1
}
}
]
}
}
]
}
Name |
Type |
Description |
Length |
|---|---|---|---|
paging.total |
integer |
The total number of records |
|
paging.limit |
integer |
The number of records per page |
1 to 100 |
paging.page |
integer |
page number |
1 to max |
customers[].id |
string |
Customer ID |
GUID |
customers[].summary.computers[].id |
string |
Device ID |
|
customers[].summary.computers[].type |
integer |
Device type |
1 = windows desktop, 2 = windows server, 3 = mac desktop, 4 = mac server, 5 = android |
customers[].summary.computers[].name |
string |
Deivce name |
|
customers[].summary.computers[].virus |
integer |
Total count of virus detections |
|
customers[].summary.computers[].spyware |
integer |
Total count of spyware detections |
|
customers[].summary.computers[].wtp |
integer |
Total count of WTP detections |
|
customers[].summary.computers[].behavior_monitoring |
integer |
Total count of Behavior Monitoring detections |
|
customers[].summary.computers[].network_virus |
integer |
Total count of network virus detections |
|
customers[].summary.computers[].url_filtering |
integer |
Total count of URL filtering detections |
|
customers[].summary.programs[].name |
string |
Program name |
|
customers[].summary.programs[].bm_id |
integer |
Behavior Monitoring ID |
|
customers[].summary.malwares[].name |
string |
Malware name |
|
customers[].summary.malwares[].type |
integer |
Malwares type |
1 = Virus, 2 = Spyware, 3 = Network Virus |
customers[].summary.malwares[].count |
integer |
Malware count |
|
customers[].summary.url_categories[].id |
integer |
URL categories ID |
|
customers[].summary.url_categories[].count |
integer |
URL categories count |
|
customers[].summary.stats.virus.deleted |
integer |
Number of virus deleted |
|
customers[].summary.stats.virus.quarantined |
integer |
Number of virus quarantined |
|
customers[].summary.stats.virus.renamed |
integer |
Number of virus renamed |
|
customers[].summary.stats.virus.passed |
integer |
Number of virus passed |
|
customers[].summary.stats.virus.cleaned |
integer |
Number of virus cleaned |
|
customers[].summary.stats.virus.uncleanable |
integer |
Number of virus uncleanable |
|
customers[].summary.stats.spyware.noncleaned |
integer |
Number of uncleaned spyware |
|
customers[].summary.stats.spyware.unsafe |
integer |
Number of unsafe spyware |
|
customers[].summary.stats.spyware.reboot |
integer |
Number of spyware require reboot |
|
customers[].summary.stats.spyware.cleaned |
integer |
Number of cleaned spyware |