Report templates
Available Variables
List of variables that can be displayed in the generated report.
List of project-related variables that can be used in the report template. For example {project.name} will display project
name used when creating a project on the platform.
| Variable | Type | Description |
|---|
project.id | number | Unique project identifier |
project.uuid | string | Project UUID |
project.name | string | Project name |
project.description | string | Project description |
project.start_at | string | Project start date/time |
project.end_at | string | Project end date/time |
project.type | string | Project type name |
| Variable | Type | Description |
|---|
client.id | number | Client identifier |
client.company_name | string | Client company name |
| Variable | Type | Description |
|---|
members | array | List of team members (excluding managers) |
members_all | array | List of all team members |
Member object:
| Field | Type | Description |
|---|
id | number | Member ID |
name | string | Member name |
email | string | Member email |
| Variable | Type | Description |
|---|
targets | array | List of assessment targets |
Target object:
| Field | Type | Description |
|---|
id | number | Target ID |
endpoint | string | Target endpoint |
note | string | Target note |
| Variable | Type | Description |
|---|
report.id | number | Report ID |
report.uuid | string | Report UUID |
report.title | string | Report title |
report.version | string | Report version |
report.created_at | string | Report creation date/time |
report.additional_fields | object | Additional custom fields |
report.executive_summary | string | Executive summary |
| Variable | Type | Description |
|---|
criticalCount | number | Number of critical findings |
highCount | number | Number of high findings |
mediumCount | number | Number of medium findings |
lowCount | number | Number of low findings |
infoCount | number | Number of informational findings |
criticalCvssCount | number | Number of critical CVSS findings |
highCvssCount | number | Number of high CVSS findings |
mediumCvssCount | number | Number of medium CVSS findings |
lowCvssCount | number | Number of low CVSS findings |
infoCvssCount | number | Number of informational CVSS findings |
findingsTotalCount | number | Total number of findings |
| Variable | Type | Description |
|---|
vulnerabilities | array | List of vulnerabilities |
Vulnerability object:
| Field | Type | Description |
|---|
id | number | Vulnerability ID |
uuid | string | Vulnerability UUID |
title | string | Vulnerability title |
description | string | Vulnerability description |
poc | string | Proof of concept |
risks | string | Risks associated |
remediation | string | Remediation steps |
cvss | string | CVSS vector |
cvss_score | number | CVSS base score |
probability | string | Probability rating |
impact | string | Impact rating |
has_affected_hosts | bool | True if affected hosts exist |
affected_hosts | array | List of affected hosts |
categories | array | List of category objects |
categories_text | string | Comma-separated category names |
categories_text_ids | string | Category IDs (one per line) |
categories_ids | array | Array of category IDs |
cvss_risk | string | Risk level based on CVSS score |
extra_fields | object | Additional custom fields |
risk | string | Criticality rating |
cvssRisk | string | Risk level based on CVSS score |
redBackground | object | Cell background color info |
assessment_domain | string | Assessment domain name |
order_id | number | Order index in report |
Affected host object:
| Field | Type | Description |
|---|
id | number | Host ID |
endpoint | string | Host endpoint |
note | string | Host note |
Category object:
| Field | Type | Description |
|---|
id | number | Category ID |
name | string | Category name |
| Variable | Type | Description |
|---|
manager.id | number | Manager ID |
manager.name | string | Manager name |
manager.email | string | Manager email |
| Variable | Type | Description |
|---|
report_date | string | Date of report generation |