---
updatedAt: 2026-06-24T21:48:09.000Z
agentTools:
  projectIndex: https://docs.sandflysecurity.com/llms.txt
---

# Scan performance report

Scan performance report.

# OpenAPI definition

```json
{
  "openapi": "3.0.1",
  "info": {
    "contact": {
      "email": "info@sandflysecurity.com"
    },
    "description": "Sandfly Security Server API",
    "license": {
      "name": "Sandfly Security, Ltd.",
      "url": "https://www.sandflysecurity.com"
    },
    "title": "Sandfly API",
    "version": "5.8.0"
  },
  "servers": [
    {
      "url": "https://{sandfly-api-host}/v4"
    }
  ],
  "security": [
    {
      "bearerAuth": []
    }
  ],
  "paths": {
    "/reports/scan_performance": {
      "get": {
        "parameters": [
          {
            "description": "Scan performance from X date-time.",
            "in": "query",
            "name": "begin",
            "required": false,
            "schema": {
              "format": "date-time",
              "type": "string"
            }
          },
          {
            "description": "Scan performance to X date-time.",
            "in": "query",
            "name": "end",
            "required": false,
            "schema": {
              "format": "date-time",
              "type": "string"
            }
          },
          {
            "description": "Limit results to 100 days.",
            "in": "query",
            "name": "limit",
            "required": false,
            "schema": {
              "type": "boolean"
            }
          }
        ],
        "description": "Scan performance report.",
        "summary": "Scan performance report",
        "operationId": "getScanPerformance",
        "responses": {
          "200": {
            "description": "Get scan performance successful.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ScanPerformanceReport"
                }
              }
            }
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/StandardResponse"
                }
              }
            },
            "description": "Unexpected error"
          }
        },
        "tags": [
          "Reports"
        ]
      }
    }
  },
  "components": {
    "schemas": {
      "ScanPerformanceReport": {
        "type": "object",
        "required": [
          "start_time",
          "end_time",
          "scan_summary",
          "hourly_scan_summary",
          "host_scan_summary",
          "tag_alerts"
        ],
        "properties": {
          "start_time": {
            "type": "string",
            "format": "date-time",
            "description": "Start time of this report data period."
          },
          "end_time": {
            "type": "string",
            "format": "date-time",
            "description": "End time of this report data period."
          },
          "scan_summary": {
            "type": "array",
            "description": "Aggregate counts of scan activity.",
            "items": {
              "type": "object",
              "required": [
                "unique_hosts_scanned"
              ],
              "properties": {
                "unique_hosts_scanned": {
                  "type": "integer",
                  "description": "Number of unique hosts scanned."
                }
              },
              "allOf": [
                {
                  "$ref": "#/components/schemas/ScanSummary"
                }
              ]
            }
          },
          "hourly_scan_summary": {
            "type": "array",
            "description": "Hourly summary of scan activity.",
            "items": {
              "type": "object",
              "required": [
                "unique_hosts_scanned",
                "time_bucket"
              ],
              "properties": {
                "time_bucket": {
                  "type": "string",
                  "format": "date-time",
                  "description": "The hour to which this data applies."
                },
                "unique_hosts_scanned": {
                  "type": "integer",
                  "description": "Number of unique hosts scanned during this time period."
                }
              },
              "allOf": [
                {
                  "$ref": "#/components/schemas/ScanSummary"
                }
              ]
            }
          },
          "host_scan_summary": {
            "type": "array",
            "items": {
              "type": "object",
              "required": [
                "host_id",
                "target_address",
                "node_name",
                "host_sequence_id"
              ],
              "properties": {
                "host_id": {
                  "type": "string",
                  "description": "Host ID."
                },
                "host_sequence_id": {
                  "type": "integer",
                  "description": "Host sequence ID. Will be null if the host has been deleted."
                },
                "target_address": {
                  "type": "string",
                  "description": "Target address of host."
                },
                "node_name": {
                  "type": "string",
                  "description": "OS-report hostname."
                }
              },
              "allOf": [
                {
                  "$ref": "#/components/schemas/ScanSummary"
                }
              ]
            }
          },
          "tag_alerts": {
            "type": "array",
            "description": "Alert result counts by sandfly tag.",
            "items": {
              "type": "object",
              "required": [
                "tag",
                "alerts",
                "category"
              ],
              "properties": {
                "tag": {
                  "type": "string",
                  "description": "Sandfly tag name."
                },
                "alerts": {
                  "type": "integer",
                  "description": "Number of alert results for this tag."
                },
                "category": {
                  "$ref": "#/components/schemas/ResultTagCategory"
                }
              }
            }
          }
        }
      },
      "ScanSummary": {
        "type": "object",
        "required": [
          "total_scans_completed",
          "total_scans_failed",
          "unique_hosts_scanned",
          "total_sandflies_executed",
          "total_alerts",
          "total_errors",
          "total_passes"
        ],
        "properties": {
          "total_scans_completed": {
            "type": "integer",
            "description": "Number of scans successfully completed."
          },
          "total_scans_failed": {
            "type": "integer",
            "description": "Number of scans that experienced scan errors."
          },
          "unique_hosts_scanned": {
            "type": "integer",
            "description": "Number of hosts scanned."
          },
          "total_sandflies_executed": {
            "type": "integer",
            "description": "Number of individual sandflies executed across hosts."
          },
          "total_alerts": {
            "type": "integer",
            "description": "Number of alert results."
          },
          "total_errors": {
            "type": "integer",
            "description": "Number of error results."
          },
          "total_passes": {
            "type": "integer",
            "description": "Number of pass results."
          }
        }
      },
      "StandardResponse": {
        "allOf": [
          {
            "$ref": "#/components/schemas/StandardResponseStatus"
          }
        ],
        "properties": {
          "data": {
            "description": "Data that can go along with the status.",
            "type": "string"
          }
        },
        "required": [
          "data"
        ],
        "type": "object"
      },
      "StandardResponseStatus": {
        "properties": {
          "detail": {
            "description": "Extended explanation of status.",
            "type": "string"
          },
          "formattedDetail": {
            "description": "Optional additional details about the status (typically an error) that, if present and not an empty string, should be displayed as pre-formatted, monospaced text.",
            "type": "string"
          },
          "status": {
            "description": "HTTP status code.",
            "format": "int32",
            "maximum": 599,
            "minimum": 100,
            "type": "integer"
          },
          "title": {
            "description": "Short description of status.",
            "type": "string"
          }
        },
        "required": [
          "status",
          "title",
          "detail"
        ],
        "type": "object"
      },
      "ResultTagCategory": {
        "type": "string",
        "enum": [
          "tactic",
          "technique",
          "sandfly_type",
          "custom"
        ],
        "description": "Tag category."
      }
    },
    "securitySchemes": {
      "bearerAuth": {
        "bearerFormat": "JWT",
        "scheme": "bearer",
        "type": "http"
      }
    }
  }
}
```