v1/scan/statistics

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

Request URL

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

Replace faca88f7-****-****-****-c0f83848b4a9 with the scan ID you want to query, and your_api_key with your actual API key.

Request Parameters

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

Response Data 

{
    "status": "ss_success",
    "progress": 98,
    "progress_status": "aborted",
    "duration": 16,
    "aborted": true,
    "aborted_reason": "scan interrupted by signal",
    "scan_status": {
        "requests": 396,
        "avg_response_ms": 211,
        "max_response_ms": 818
    },
    "target_info": {
        "address": "securitysurface.com",
        "server": "cloudflare",
        "os": "Unknown",
        "responsive": true
    },
    "vuln_counts": {
        "crit": 0,
        "high": 0,
        "medium": 0,
        "low": 0,
        "info": 0
    },
    "discovered_hosts": [
        "https://app.securitysurface.com",
        "https://seal.godaddy.com",
        ...
    ]
}