Reports API
Read reseller-level usage, training, and phishing report data.
| Method | Endpoint | Description |
|---|
| GET | /v1/reseller/reports/usage | Get usage statistics. |
| GET | /v1/reseller/reports/training | Get training completion data. |
| GET | /v1/reseller/reports/phishing | Get phishing simulation data. |
Query Parameters
| Parameter | Type | Description |
|---|
| start_date | string | Start date in YYYY-MM-DD format. |
| end_date | string | End date in YYYY-MM-DD format. |
| company_id | integer | Optional company filter. |
| group_by | string | Grouping such as company, month, or department. |
Report Metrics
| Metric | Description |
|---|
| active_companies | Companies currently active. |
| total_users | Users across all companies. |
| training_completion_rate | Percentage of completed assigned training. |
| phishing_click_rate | Percentage of phishing emails with link clicks. |
| report_rate | Percentage of phishing emails reported by users. |