Skip to main content

Report Overview

This article details reports in the Brinqa Platform and how to create or edit reports using Brinqa's flexible and powerful report builder. For a detailed tutorial on how to create a report with multiple sections, see the Build a Custom Report article.

Introduction to reports

Reports in the Brinqa Platform are extremely flexible and powerful due to the graph data model and the use of API calls to retrieve data. It allows the system to dynamically create subsets of data based on any attributes in a data model, provide in-report filtering, and display data on reports more quickly. Reports give you a way to present, visualize, and analyze the cybersecurity data collected from various data sources, such as vulnerability scanners, asset management systems, and threat intelligence feeds. Reports enable you to gain insights into you organization's security posture, track the progress of risk mitigation efforts, and make data-driven decisions to improve your overall cybersecurity posture.

Reports in the Brinqa Platform can be customized and tailored to meet the specific needs of different stakeholders within your organization, such as executives, security managers, or IT teams. Reports can include various charts, graphs, and tables, displaying information such as risk scores, vulnerability trends, or asset inventory.

Here are some common types of reports you can build in the Brinqa Platform:

  • Executive summary: Provide an overview of your organization's cybersecurity posture and highlight key risk metrics.

  • Risk and vulnerability: Offer detailed information on risk scores, vulnerabilities, and remediation status for individual assets or groups of assets.

  • Compliance reports: Help you monitor your organization's compliance with relevant regulatory standards or industry best practices.

  • Trend reports: Track changes in your security posture over time, identifying emerging threats and the effectiveness of remediation efforts.

Navigate to Analytics to view or modify existing reports and create new reports in your Brinqa Platform.

The Dashboards page is similar to Reports with many of the same elements on both pages. You can add to the dashboard any section you add to a report. However, while you can configure multiple reports, you only have one dashboard. Think of your dashboard as a centralized view of what you consider the most important pieces of data in your Brinqa Platform.

Create a new report

While your Brinqa Platform contains some default reports built in, you can also create your own reports as desired. To create a new report, follow these steps:

  1. Navigate to Analytics.

  2. Click Create and in the Setup tab, fill in the following information:

    • Header: The header of the report. The header appears at the top of the specific report page.

    • Title: The title of your report. The title is displayed on the report list view.

    • Name: The referenced name of the report for queries and scripts. The system fills in the name as you type the title, removing any spaces or characters that are not allowed. You do not need to edit this field.

    • Description: The description of the report. The description is displayed on the report list view and can be searched using the search bar.

  3. Click Save. The page reloads and you can now add sections to your report or customize its appearance.

Customize report appearance

After creating a new report, you can modify the appearance of the report. To do so, follow these steps:

  1. Navigate to Analytics and choose the report you want to modify.

  2. Click Edit, then Customize, and edit the following fields as needed:

    • Width and margin: Customize the width and the four margins of the report. You can also select Fit to width and No margin.

    • Background and border: Customize the report background color, border color, border width, border radius, or enable a border shadow.

    • Sections background and border: Customize the background and borders of the sections on the report.

    • Actions: Enable fullscreen for the report.

  3. Click Update.

Add inputs

You can add inputs to your report, which enable you to dynamically filter the contents of the entire report. For example, you can create a vulnerability report that initially displays information about all existing vulnerabilities in your instance. Then you can add an input to only show information on the vulnerabilities found in the last 30 days.

To add different inputs to your report, follow these steps:

  1. Navigate to Analytics.

  2. Click the report you want to change the input for.

  3. Click Edit and then click Inputs add input button.

  4. Click the Data model drop-down and choose the same data model as the report to which you are adding the input. For example, if you are creating a report that targets the Vulnerability data model, choose Vulnerability.

  5. Click More and choose the attribute for the filter. For example, Status.

  6. Click Apply.

  7. Click the attribute to choose the operators. For example, if you selected the Status attribute, click Status and choose the status category you want to filter for. Options include: Active, Fixed, Reopened, or Risk accepted.

  8. Click Apply, and then Update.

The new input limits the vulnerability data for the report, including all sections on the report, to only the status category indicated in step 7. If you do not want this filter to be applied to a certain section, edit the section and select Ignore input filtering.

Repeat these steps for each input you want to add to your report. See step 6 in the Build your own report tutorial to see how an input can change the data presented in your reports.

View source

While editing your report, you can view, edit, or copy the source code for the entire report. Copying the source code of a report can be helpful when you want to create a new report without starting from scratch. To view the source code of a report, follow these steps:

  1. Navigate to Analytics.

  2. Click the report you want to view or edit the source for.

  3. Click Edit.

  4. Click View source view source.

Edit or delete a report

You can edit or delete existing reports. Hold the pointer over the report you want to modify and click Edit or Delete.

Tabular report limitations

When you create a Tabular report section, the report builder limits the display to a maximum of 100 rows at a time. This limitation, designed to help maintain system performance, prevents your web browser from slowing down when rendering large amounts of data sets.

Tabular report section with a limit of 100 rows

If you configure your Tabular report section to display more than 100 rows using a Brinqa Query Language (BQL) query, as shown in the following example, the system still limits the view to only the first 100 rows.

Advanced mode changing the limit to 500 results

If you configure your Tabular report section to exceed the data limit of 100 rows, the following warning message appears at the bottom of the Tabular section:

"(!) Data limit exceeded. We are displaying the first 100 rows. To view all the results, export it here".

You can click the export link to download and access all your results beyond the initial 100 rows as a .csv file. This method ensures that you can handle extensive data sets without impacting system performance. To export your tabular report section data, follow these steps:

  1. Navigate to the report containing the Tabular report section results you want to export.

  2. Scroll to the bottom of the Tabular report section and in the warning message, click here.

    The export dialog window displays.

  3. Provide a name for the export, and then click Export.

    Export dialog window

  4. Navigate to Account Account icon > Exports.

  5. Click the name of the export. A new page appears.

  6. Click Download.

    The .csv file containing the entirety of the Tabular results downloads directly to your local storage.