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": 91,
    "status": "aborted",
    "duration": 2167,
    "aborted": true,
    "aborted_reason": "scan interrupted by signal",
    "scan_status": {
        "paths_identified": 192,
        "requests": 19609,
        "avg_response_ms": 386,
        "max_response_ms": 26324
    },
    "target_info": {
        "address": "example.com",
        "server": "unknown",
        "os": "Unknown",
        "responsive": true
    },
    "vuln_counts": {
        "crit": 0,
        "high": 0,
        "medium": 1,
        "low": 0,
        "info": 1
    },
    "vulns": [
        {
            "vuln_id": "3480715660269454580",
            "severity": 0,
            "name": "Outdated JavaScript libraries",
            "time": "2024-10-17T16:27:46.546339+08:00"
        },
        {
            "vuln_id": "3480715443759482097",
            "severity": 2,
            "name": "Vulnerable JavaScript libraries",
            "time": "2024-10-17T16:27:20.738578+08:00"
        }
    ],
    "discovered_hosts": [
        "https://example.com",
        "https://example.com",
        "https://example.com"
    ]
}