Report Token: {Finding_Chart}

This guide explains how to use the finding chart token in reports using a query string-like syntax.

Basic Structure

The token uses URL-style parameters separated by & characters. For example:

{Finding_Chart?type=pie&dimension=severity&setting.sort.direction=ascending&
setting.filter.type=Vulnerability}

This will be replace by a pie chart of Findings (Vulnerabilities only) by severity.

Configuration Sections

1. Required parameters

These are the required parameters and their options:

type=[bar,pie]&
dimension=[status,severity,vulnerability_type,label]&
display=[count,percentage]&

Important Note for Labels: When setting dimension=label, you must also include the setting.filter.labels=<labels>

2. Size

You can configure the size by adding the size configuration:

setting.size.width=900(default)&
setting.size.height=220(default)&

3.Filtering and Sorting (Optional)

Filter findings by various criteria:

setting.filter.type=Vulnerability&
setting.filter.status=ReadyRetest,PendingFix&
setting.filter.severity=Critical,High&
setting.filter.labels=Security,PCI-DSS&
setting.sort.direction=Ascending&

HTML Structure and CSS Classes

The Finding Chart token generates a chart with configurable dimensions.

Root Container

<div class="finding-chart-container">

Purpose: Top-level container for all the chart content

CSS Classes:

• finding-chart-container: Base wrapper class

Examples

Here's an example combining multiple settings:

Pie chart with vulnerabilities by severity, filtered by label

{Finding_Chart?type=pie&dimension=severity&
setting.sort.direction=ascending&
setting.filter.type=Vulnerability&setting.filter.labels=<labels>}

Bar chart with vulnerabilities by severity, filtered by label

{Finding_Chart?type=bar&dimension=severity&
setting.sort.direction=ascending&setting.filter.type=Vulnerability&
setting.filter.labels=<labels>}

Pie chart with vulnerability types by severity

{Finding_Chart?type=pie&dimension=vulnerability_type&
display=count&setting.sort.direction=ascending&
setting.filter.type=Vulnerability}

Pie chart with findings, filtered by labels

{Finding_Chart?type=pie&dimension=label&
display=count&setting.sort.direction=descending&
setting.filter.type=Vulnerability&setting.filter.labels=<labels>}