v1/scan/statistics

This API provides detailed statistics for a specific scan, including progress, status, vulnerabilities found, and other relevant information.

Request URL

curl -X GET "https://api.securitysurface.com/v1/scan/statistics?scan_id={scan_id}}" \
-H "apikey: your_api_key" \
-H "Content-Type: application/json"

Request Parameters

Parameter Type Location Required Description
scan_id string query Yes The unique identifier of the scan

Response Data 


{
    "progress": 100,
    "status": "completed",
    "duration": 2167,
    "aborted": false,
    "aborted_reason": "",
    "scan_status": {
        "paths_identified": 0,
        "requests": 0,
        "avg_response_ms": 0,
        "max_response_ms": 0
    },
    "target_info": {
        "address": "example.com",
        "server": "unknown",
        "os": "Unknown",
        "responsive": true
    },
    "vuln_counts": {
        "crit": 0,
        "high": 0,
        "medium": 1,
        "low": 0,
        "info": 1
    },
    "discovered_hosts": [
        "https://example.com",
        "https://example.com",
        "https://example.com"
    ]
}