Summary of scan

Description

Retrieve scan history

URL Path

/stat/scanhistory/{n_hour}

Method

GET

Summary

Retrieve history of scanning in last n hours.

HTTP header parameters

apikey

API key assigned by OPSWAT or admin

REQUIRED

Response Codes

200

OK

successful response

400

Bad request

Not supported HTTP method or invalid http request

401

Permission Denied for statistic

Either missing API key or invalid api is passed

500

Internal server error

Server temporary unavailable. Try again later.

Response

Example of successful scan request:

200
[
{
"total_scanned_files": 101,
"total_infected": 0,
"total_blocked": 1,
"avg_scan_time": 19.712871287129,
"localtime": "2013-11-11T11:00:00+07:00"
},
{
"total_scanned_files": 3,
"total_infected": 0,
"total_blocked": 2,
"avg_scan_time": 113.66666666667,
"localtime": "2013-11-11T10:00:00+07:00"
},
{
"total_scanned_files": 5,
"total_infected": 1,
"total_blocked": 1,
"avg_scan_time": 25.455566656565,
"localtime": "2013-11-11T09:00:00+07:00"
}
]

Descriptions of response:

avg_scan_time

Average scanning time

total_infected

all logs with scan_result_i of 1, 2, 4, 6, 8

total_blocked

All logs that have process_info.result equal to "Blocked"