Phishing Data API
Read phishing simulation outcomes, aggregate phishing reports, and user risk score distributions.
| Method | Endpoint | Description |
|---|
| GET | /v1/company/users/{id}/phishing | Get user phishing results. |
| GET | /v1/company/reports/phishing | Get aggregate phishing report. |
| GET | /v1/company/reports/risk-scores | Get risk score distribution. |
Phishing Result Fields
| Field | Type | Description |
|---|
| summary.total_campaigns | integer | Total phishing attempts sent to the user. |
| summary.opened | integer | Emails the user opened. |
| summary.clicked | integer | Links the user clicked. |
| summary.reported | integer | Emails the user reported. |
| summary.click_rate | float | Percentage of emails clicked. |
| summary.report_rate | float | Percentage of emails reported. |
| attempts[].is_opened | boolean | Whether the user opened the email. |
| attempts[].is_clicked | boolean | Whether the user clicked the phishing link. |
| attempts[].is_reported | boolean | Whether the user reported the email. |
Risk Score Ranges
| Level | Score Range | Description |
|---|
| low | 0-25 | Minimal risk. |
| medium | 26-50 | Moderate risk. |
| high | 51-75 | Elevated risk. |
| critical | 76-100 | Requires immediate attention. |
Phishing Attempt Flags
| Flag | Description |
|---|
| is_opened | The user opened the phishing email. |
| is_clicked | The user clicked the phishing link. |
| is_reported | The user reported the email as suspicious. |
| is_replied | The user replied to the phishing email. |