Reports
Reports turn scans, findings and uptime into something you can hand to a client, a manager or an auditor.
Report types
| Report | Contents | Formats |
|---|---|---|
| Exposure and uptime report | Grade, open and fixed findings, assets seen and uptime for a period, for all domains or one. | HTML (print to PDF), Markdown, JSON |
| Monthly report | The same report for a calendar month. Choose the month on the Reports page. A summary is also sent as a notification when a month closes. | HTML, Markdown, JSON |
| Compliance report | Control-by-control evidence for one framework. See Compliance. | HTML, Markdown, JSON |
| Prospect report | A passive scan of a company you want to win. MSP plans only. | HTML, Markdown, JSON |
The HTML version is designed to print. Add print=1 to open the browser print dialog straight away. Every export other than JSON is written to the audit log.
Shareable link
Analysts can create a link to a domain's report that works without an account, so you can send it to a client or board member. Links expire after 14 days and are listed in the audit log. Prospect domains need an MSP plan.
Options
- Period: the last 1 to 365 days (30 by default), or a calendar month in the form YYYY-MM that is not in the future.
- Scope: the whole workspace, or one domain.
- Exports are rate limited to twenty a minute.
API
| Method | Path | Role | What it does |
|---|---|---|---|
GET | /api/orgs/:orgId/reports/exposure?format=&domainId=&days=&month=&print= | viewer | format is json, md or html. |
GET | /api/orgs/:orgId/reports/compliance?framework=&format=&clientId= | viewer | Compliance evidence report. |
POST | /api/orgs/:orgId/domains/:domainId/report-share | analyst | Returns a public URL and its expiry. |