> ## Documentation Index
> Fetch the complete documentation index at: https://docs.aiptx.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Reports Overview

> Generate comprehensive penetration test reports

# Reports Overview

AIPTx generates professional penetration test reports that communicate findings effectively to different stakeholders.

## Report Types

<CardGroup cols={2}>
  <Card title="Executive Report" icon="briefcase">
    High-level summary for leadership and stakeholders. Focuses on business impact and risk scores.
  </Card>

  <Card title="Technical Report" icon="code">
    Detailed findings for security and development teams. Includes PoC code and remediation steps.
  </Card>

  <Card title="Compliance Report" icon="file-certificate">
    Maps findings to compliance frameworks. Includes control assessments and gap analysis.
  </Card>

  <Card title="Developer Report" icon="laptop-code">
    Code-focused format optimized for development teams. Includes file references and fix examples.
  </Card>
</CardGroup>

## Generating Reports

### Via CLI

```bash theme={null}
# Generate PDF report
aiptx report generate --scan-id scan_abc123 --format pdf

# Generate with specific template
aiptx report generate --scan-id scan_abc123 --template executive --format pdf

# Generate compliance report
aiptx report generate --scan-id scan_abc123 --template compliance --compliance soc2,pci
```

### Via Dashboard

1. Navigate to the completed scan
2. Click **Generate Report**
3. Select template and format
4. Click **Generate**

### Via API

```bash theme={null}
curl -X POST "https://api.aiptx.io/v1/reports" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
    "scan_id": "scan_abc123",
    "format": "pdf",
    "template": "technical"
  }'
```

## Report Sections

### Executive Summary

* Overall risk score and rating
* Critical findings overview
* Business impact assessment
* Trend comparison with previous scans
* Key recommendations

### Findings Summary

| Severity | Count | Status  |
| -------- | ----- | ------- |
| Critical | 2     | Open    |
| High     | 5     | Open    |
| Medium   | 12    | 3 Fixed |
| Low      | 23    | 5 Fixed |

### Detailed Findings

Each finding includes:

* **Title and Severity** - Clear identification
* **Description** - What the vulnerability is
* **Location** - Affected endpoint/parameter
* **Impact** - Potential business consequences
* **Proof of Concept** - Evidence of exploitation
* **Remediation** - How to fix it
* **References** - OWASP, CWE, CVE links

### Risk Analysis

```
Risk Score: 78/100 (High)

Risk Breakdown:
├── Critical Findings: +40 points
├── High Findings: +25 points
├── Exposure Level: +8 points
└── Asset Criticality: +5 points
```

## Output Formats

### PDF

Professional formatted document suitable for:

* Executive presentations
* Compliance audits
* Client deliverables
* Archival purposes

### HTML

Interactive web-based report with:

* Clickable navigation
* Expandable sections
* Syntax-highlighted code
* Search functionality

### JSON

Machine-readable format for:

* Integration with other tools
* Custom processing
* Data analysis
* Archival storage

### CSV

Spreadsheet format for:

* Bulk data analysis
* Import into tracking systems
* Custom reporting
* Trend analysis

### SARIF

Static Analysis Results Interchange Format for:

* IDE integration
* CI/CD pipelines
* GitHub/GitLab security dashboards
* Standardized tool interoperability

## Customization

### Branding

Add your company branding:

```yaml theme={null}
branding:
  company_name: "Acme Security"
  logo_url: "https://example.com/logo.png"
  primary_color: "#1a73e8"
  footer_text: "Confidential - For Internal Use Only"
```

### Custom Sections

Include additional sections:

```yaml theme={null}
custom_sections:
  - title: "Scope of Work"
    content: |
      This assessment covered the production web application
      at https://app.example.com including all API endpoints.

  - title: "Testing Methodology"
    content: |
      Testing was performed using AIPTx automated scanning
      with manual verification of critical findings.
```

### Filtering

Generate reports with filtered findings:

```bash theme={null}
# Only critical and high
aiptx report generate --scan-id scan_abc123 --severity critical,high

# Exclude accepted findings
aiptx report generate --scan-id scan_abc123 --exclude-status accepted

# Specific categories
aiptx report generate --scan-id scan_abc123 --category injection,authentication
```

## Scheduled Reports

Set up automated report generation:

```yaml theme={null}
schedule:
  frequency: weekly
  day: monday
  time: "09:00"
  timezone: "America/New_York"

delivery:
  email:
    - security@example.com
    - ciso@example.com
  slack: "#security-reports"

format: pdf
template: executive
```

## Report Sharing

### Secure Links

Generate time-limited shareable links:

```bash theme={null}
aiptx report share --report-id report_xyz --expires 7d --password
```

Output:

```
Share URL: https://reports.aiptx.io/s/abc123xyz
Password: SecurePass123
Expires: 2024-01-22
```

### Access Control

Configure who can access reports:

* Team members only
* Specific email domains
* Password protection
* IP restrictions (Enterprise)