Generating Symantec Protection Engine scan usage statistics
Article ID: 453601
Updated On:
Products
Issue/Introduction
You need to gather scan statistics for your own reporting or other compliance reasons. The built-in SPE Rest API provides another method for gathering this data rather than manually collecting report.xml.
Environment
- Symantec Protection engine 9.x and later.
Resolution
The /spe/api/v1/scan-statistics API can be used to generate scan statistic data based. This API can be invoked using your existing REST API applications/scripts or through SPE's built-in Swagger-UI. This API has three parameters:
- startDate: YYYY-MM-DDTHH:MM:SS
- endDate: YYYY-MM-DDTHH:MM:SS
- type: scan
This API can be run on-demand as needed and may vary based on the SPE deployment. For SPE servers that remain online persistently, running a report monthly may be sufficient. For non-persistent SPE servers where report.xml is not retained between server shutdown/startup, the statistics would need to be gathered before the SPE is decomissioned.
Body
{
"startDate": "YYYY-MM-DDTHH:MM:SS",
"endDate": "YYYY-MM-DDTHH:MM:SS",
"type": "scan"
}Example
This example will generate an Events Report with data between January 01, 2026 12:00am and January 31, 2026 11:59pm.
{
"startDate": "2026-01-01T00:00:00",
"endDate": "2025-01-31T23:59:59",
"type": "scan"
}Example output
{
"scanStatistics": {
"fileScanCount": 0,
"totalFileScanCount": 0,
"dataScannedInMegaBytes": 0,
"totalDataScannedInMegaBytes": 0,
"fileAllowByHashCount": 0,
"fileDeniedByHashCount": 0,
"fileQuarantinedCount": 0,
"scanRequestCount": 0
}
}This output can then be provided as needed along with the date range the data was collected for.
Additional Information
Feedback
