BPAReport

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "BPAReport",
  "description": "BPAReport schema from Palo Alto Networks AIOps for NGFW BPA API",
  "$id": "https://raw.githubusercontent.com/api-evangelist/palo-alto-networks/refs/heads/main/json-schema/aiops-ngfw-bpa-api-bpa-report-schema.json",
  "type": "object",
  "properties": {
    "report_id": {
      "type": "string",
      "description": "Unique identifier of the report."
    },
    "request_id": {
      "type": "string",
      "description": "ID of the BPA request that generated this report."
    },
    "serial_number": {
      "type": "string",
      "description": "Device serial number assessed."
    },
    "pan_os_version": {
      "type": "string",
      "description": "PAN-OS version assessed."
    },
    "overall_score": {
      "type": "number",
      "format": "float",
      "description": "Overall best practice compliance score from 0.0 to 100.0.",
      "minimum": 0.0,
      "maximum": 100.0
    },
    "category_scores": {
      "type": "array",
      "description": "Compliance scores broken down by best practice category.",
      "items": {
        "type": "object",
        "properties": {
          "category": {
            "type": "string",
            "description": "Best practice category name."
          },
          "score": {
            "type": "number",
            "format": "float",
            "description": "Category compliance score (0.0 to 100.0)."
          },
          "passed": {
            "type": "integer",
            "description": "Number of checks that passed in this category."
          },
          "failed": {
            "type": "integer",
            "description": "Number of checks that failed in this category."
          },
          "not_applicable": {
            "type": "integer",
            "description": "Number of checks not applicable to this device."
          }
        }
      }
    },
    "total_checks": {
      "type": "integer",
      "description": "Total number of checks evaluated."
    },
    "passed_checks": {
      "type": "integer",
      "description": "Number of checks that passed."
    },
    "failed_checks": {
      "type": "integer",
      "description": "Number of checks that failed."
    },
    "generated_at": {
      "type": "string",
      "format": "date-time",
      "description": "Timestamp when the report was generated."
    }
  }
}