Reports

A report is the smallest building block of your dashboard. Each report has a single Cypher® query behind it populating the report with data retrieved from your Neo4j database. Reports can be of different types (graph, table, bar chart, etc.), each of which expect different types of data. See the relevant documentation pages for more information.

A report can have a title, which is displayed in the dashboard header. To change the query of a report, open the settings by clicking the (⋮) icon on the top right of the report widget.

The settings window also allows you to change the type and the refresh rate of the report, and a number of Advanced Settings. The advanced settings differ between the different report types, and can be viewed by toggling the switch on the bottom left of the settings page.

Creating and deleting reports

A new report can be added to a page by clicking the large (+) button at the end of the page. By default, a report has nothing defined. You must specify a Cypher query before any data is visualized.

Reports can be deleted by opening the report settings and clicking the 🗑️ icon in the report header.

Re-ordering reports

You can re-order reports by dragging and dropping them around the page. To move a report, grab it by the handle (top left corner), and drag it to the desired location.

Resizing reports

You can resize reports by grabbing their bottom-right corner, and dragging your mouse to the desired size.

Writing queries

A single Cypher query is used to populate each report. Any Cypher syntax is supported, including APOC, GDS, and even Fabric.

Keep the following best practices in mind when writing your Cypher queries:

  1. Always use a LIMIT in your query to keep the result size manageable.

  2. Ensure that you return the correct data types for the correct report type. For example, a graph report expects nodes and relationships, whereas a line chart expects numbers.

Row limiting

NeoDash has a built-in post-query row limiter. This means that results are truncated to a maximum number of rows, depending on the report type. The row limiter ensures that visualizations do not become too complex for the browser to display.

Note that even though the row limiter is enabled by default, rows are only limited after the query is executed. Therefore, it is recommended to use the LIMIT clause in your query at all times.

Parameters

Parameters can be set in a dashboard by using a Parameter select report. Set parameters are then available in any Cypher query across the dashboard.

In addition, session parameters are available based on the currently active database connection.

Parameter

Description

$session_uri

The URI of the current active database connection.

$session_database

The Neo4j database that was connected to when the user logged in.

$session_username

The username used to authenticate to Neo4j.