Dashboard Configuration

Navigation Sections

Seizu’s navigation supports a dashboard and an arbitrary number of reports. The dashboard is the landing page, and is meant as a general overview of the data in your graph. Reports are topic-specific views of your graph data.

Both the dashboard and reports use a list of rows, which contain a list of panels; both are grid-based. Rows are rendered in the order specified, and panels within rows are also rendered in the order specified.

Configuration Storage

Report and dashboard configurations are stored in DynamoDB, not in the YAML configuration file. The YAML file contains a top-level queries dict (used only by scheduled_queries references), scheduled_queries, a dashboard pointer, a reports section, and a toolsets section — all used to seed DynamoDB. Each report has its own queries dict for named Cypher strings used by its panels.

To populate DynamoDB from the YAML file during initial setup or development:

make seed_dashboard

The dashboard key in the YAML file is a string that names a report in the reports section to use as the default dashboard:

dashboard: dashboard   # pointer to the "dashboard" entry in reports

reports:
  dashboard:
    name: Dashboard
    queries:
      cves-total: |-
        MATCH (c:CVE)
        RETURN count(c.id) AS total
    rows:
      - name: Overview
        panels:
          - cypher: cves-total       # reference to a named query in this report's queries dict
            type: count
            caption: Total CVEs
            size: 3
          - cypher: |-               # direct Cypher string — no named reference needed
              MATCH (c:CVE)
              RETURN count(c.id) AS total
            type: count
            caption: Total CVEs (direct)
            size: 3

To change the dashboard at runtime, use the Reports list in the UI (see below) or call the API directly:

curl -X PUT /api/v1/reports/<report_id>/dashboard

Managing Reports

Reports can be created, edited, and deleted at runtime through the Seizu UI without modifying the YAML file or restarting the service.

Permissions: Creating and editing reports requires the reports:write permission (seizu-editor or seizu-admin). Deleting reports requires reports:delete. Setting the default dashboard requires reports:set_dashboard. Pinning reports requires reports:write. Restoring a historical version also requires reports:write. Users with only the seizu-viewer role can view reports and history but will not see the New report button, and write/delete/restore actions in the ⋮ menu and version view will be disabled.

Reports list

Navigate to Reports in the sidebar to view all reports. From the list you can:

• Click a report name to view it.

• Open the ⋮ menu on any row to Edit, View history, Set as dashboard, Pin to sidebar / Unpin from sidebar, or Delete a report.

• A Pinned badge is shown inline on reports that are pinned to the sidebar.

• A Dashboard badge is shown inline on whichever report is currently set as the dashboard.

Pinning reports to the sidebar

Pinning a report adds it as a direct link under Reports in the navigation sidebar, so it can be reached in one click without going through the Reports list. Only pinned reports appear in the sidebar — the full list is always accessible via the Reports navigation item.

To pin or unpin a report, open the ⋮ menu on its row in the Reports list and choose Pin to sidebar or Unpin from sidebar. This requires the reports:write permission.

Creating a report

Click New report on the Reports list page, enter a name, and confirm. An empty report is created immediately and opened in edit mode so you can start adding rows and panels.

Version history

Every save creates a new numbered version; the full history is always available. To access it:

• Click History (top-right when viewing a report), or

• Choose View history from the ⋮ menu in the Reports list.

The history page lists all versions newest-first, showing the version number, save date, author, and save comment. The current (latest) version is labeled current.

Click a version number to open a read-only view of that version. From the version view you can:

• Use the ← v_N_ / v_N_ → buttons in the toolbar to step through older and newer versions without returning to the list.

• Click Restore this version to save the historical config as a new latest version. The button is disabled when viewing the current version, or when you do not have the reports:write permission.

Restoring a version never deletes history — it creates a new version whose config matches the restored one.

Editing a report

Click Edit report (top-right when viewing a report) or choose Edit from the ⋮ menu in the Reports list. Edit mode provides:

• Named Queries — a collapsible section for defining reusable Cypher strings that panels can reference by key.

• Rows — add, rename, and delete rows. Rows hold panels in a horizontal grid.

• Panels — within each row, panels can be dragged to a new position (within a row or to a different row) and resized using the − / + column controls (1–12 grid columns). Use the pencil icon to open the panel editor, or the trash icon to remove a panel.

• Add panel — opens the panel editor where you select the panel type and fill in the relevant fields. The form adapts to show only the fields applicable to the chosen type.

Click Save version to commit your changes. Every save creates a new numbered version; existing versions are never overwritten.

Deleting a report

Choose Delete from the ⋮ menu in the Reports list and confirm. This permanently removes the report and all its versions. If the report was set as the dashboard, the dashboard pointer is also cleared.

Panels

Seizu supports various panel types that can be used to visualize graph data. See the Panel schema for more detailed info about specific fields.

count

To simply display a count of a particular query, use a count panel.

Field	Description
cypher	A cypher query to use for this panel. Either a key from the report’s queries dict, or a direct Cypher string. The query must return the count as total.
details_cypher	A cypher to use for displaying a table view of the data, in a details view. Either a key from the report’s queries dict, or a direct Cypher string. Supports the same return formats as the table panel.
params	A list of parameters to pass into the query. See the PanelParam schema for more info.
caption	The caption to show as the title of this panel.
type	The type of panel. count, for this panel type.
metric	The statsd metric to push for this panel, if stats pushing is enabled.
size	The width of this panel.

Example

        - cypher: cves
          details_cypher: cves-details
          caption: Total CVEs
          metric: cves.total
          type: count
          size: 3

progress

To display a progress wheel, and x/y display of a particular query, use a progress panel. By default, this panel will color the progress data based on a threshold of <70% error, >70% <100% primary, 100% success.

Field	Description
cypher	A cypher query to use for this panel. Either a key from the report’s queries dict, or a direct Cypher string. The query must return the counts as numerator and denominator.
details_cypher	A cypher to use for displaying a table view of the data, in a details view. Either a key from the report’s queries dict, or a direct Cypher string. Supports the same return formats as the table panel.
params	A list of parameters to pass into the query. See the PanelParam schema for more info.
caption	The caption to show as the title of this panel.
type	The type of panel. progress, for this panel type.
threshold	The lower threshold percentage to consider this result an error. Set to 0 to disable threshold. Default: 70
metric	The statsd metric to push for this panel, if stats pushing is enabled.
size	The width of this panel.

Example

        - cypher: cve-by-severity
          details_cypher: cve-by-severity-details
          params:
            - name: severity
              value: CRITICAL
          caption: Critical CVEs
          type: progress
          threshold: 0
          size: 3

pie

To display a pie graph, use a pie panel.

Field	Description
cypher	A cypher query to use for this panel. Either a key from the report’s queries dict, or a direct Cypher string. The query must return rows with keys id and value; example: RETURN {id: c.base_severity, value: count(c.id)} AS details
details_cypher	A cypher to use for displaying a table view of the data, in a details view. Either a key from the report’s queries dict, or a direct Cypher string. Supports the same return formats as the table panel.
params	A list of parameters to pass into the query. See the PanelParam schema for more info.
caption	The caption to show as the title of this panel.
type	The type of panel. pie, for this panel type.
pie_settings	An object of settings specific to pie panels.
pie_settings.legend	Orientation of the legend. row or column. If legend is not set, no legend will be shown, and arc labels will be shown instead.
size	The width of this panel.

Example

        - cypher: cves-by-severity-as-rows
          caption: Critical CVEs
          type: pie
          pie_settings:
            legend: column
          size: 3

bar

To display a bar graph, use a bar panel.

Field	Description
cypher	A cypher query to use for this panel. Either a key from the report’s queries dict, or a direct Cypher string. The query must return rows with keys id and value; example: RETURN {id: c.base_severity, value: count(c.id)} AS details
details_cypher	A cypher to use for displaying a table view of the data, in a details view. Either a key from the report’s queries dict, or a direct Cypher string. Supports the same return formats as the table panel.
params	A list of parameters to pass into the query. See the PanelParam schema for more info.
caption	The caption to show as the title of this panel.
type	The type of panel. bar, for this panel type.
bar_settings	An object of settings specific to bar panels.
bar_settings.legend	Orientation of the legend. row or column.
size	The width of this panel.

Example

        - cypher: cves-by-severity-as-rows
          caption: Critical CVEs
          type: bar
          bar_settings:
            legend: column
          size: 3

table

To display rows in a paged table, use a table panel.

The table panel auto-detects columns from the query results. It supports three return formats:

• Named columns — RETURN n.name AS name, n.org AS org (explicit columns config maps to these)

• Map — RETURN {name: n.name, org: n.org} (or with any alias, e.g. AS row)

• Node — RETURN n (properties are unwrapped automatically)

When columns is specified in the panel config, those column names are read directly from the record keys.

Field	Description
cypher	A cypher query to use for this panel. Either a key from the report’s queries dict, or a direct Cypher string. Columns are auto-detected from the result; no specific return alias is required.
columns	Optional list of {name, label} objects to explicitly define which columns to show and their display labels. When omitted, columns are derived from the first result row.
params	A list of parameters to pass into the query. See the PanelParam schema for more info.
caption	The caption to show as the title of this panel.
type	The type of panel. table, for this panel type.
size	The width of this panel.

Example

      - name: CVEs
        panels:
          - cypher: cve-search
            params:
              - name: cveId
                input_id: cve-id-autocomplete-input
            type: table
            size: 12

vertical-table

To display rows in a less-dense, vertical per-row view, use a vertical-table panel. Note: the caption per-row is set via the table_id field, and if unset, will display undefined

Supports the same return formats as the table panel (named columns, map, or bare node).

Field	Description
cypher	A cypher query to use for this panel. Either a key from the report’s queries dict, or a direct Cypher string. Columns are auto-detected from the result; no specific return alias is required.
params	A list of parameters to pass into the query. See the PanelParam schema for more info.
caption	The caption to show as the title of this panel.
type	The type of panel. vertical-table, for this panel type.
table_id	The attribute in the result row to use as a caption for each row. If not set, row captions will show as undefined.
size	The width of this panel.

Example

      - name: CVEs
        panels:
          - cypher: cve-search
            params:
              - name: cveId
                input_id: cve-id-autocomplete-input
            type: vertical-table
            table_id: id
            size: 12

graph

To display graph data as an interactive node-link diagram, use a graph panel.

The panel has three tabs:

• Graph — interactive node-link visualization. Only shown when the query returns graph-compatible data (see formats below).

• Table — tabular view of the raw results. Always available. Columns are auto-detected from the result shape.

• Raw — JSON dump of the full API response. Always available.

Clicking a node or relationship opens a collapsible detail panel on the right showing its properties. Clicking the canvas background deselects and returns to a graph summary view. The detail panel can also be toggled via the info icon at the top of the toggle handle.

The Graph tab supports two query return formats:

Option 1 — explicit map (full control over labels and grouping):

MATCH (org:GitHubOrganization)-[:OWNER]->(repo:GitHubRepository)
WITH
  collect(DISTINCT {id: id(org), label: org.id, group: 'Org'}) +
  collect(DISTINCT {id: id(repo), label: repo.name, group: 'Repository'}) AS nodes,
  collect({source: id(org), target: id(repo), type: 'OWNER'}) AS links
RETURN {nodes: nodes, links: links}

Option 2 — RETURN path (simplest; labels use the node_label property, defaulting to name then node id):

MATCH path = (:GitHubOrganization)-[:OWNER]->(:GitHubRepository)
RETURN path LIMIT 100

If the query does not return graph-compatible data (e.g. RETURN n or a plain property query), the Graph tab is hidden and the Table tab is shown by default.

Field	Description
cypher	A cypher query to use for this panel. Either a key from the report’s queries dict, or a direct Cypher string. See formats above.
params	A list of parameters to pass into the query. See the PanelParam schema for more info.
caption	The caption to show as the title of this panel.
type	The type of panel. graph, for this panel type.
graph_settings	An object of settings specific to graph panels.
graph_settings.node_label	The node property to display as the node label. Defaults to label (explicit map) or name then node id (path format).
graph_settings.node_color_by	The node property to use for color grouping. Defaults to group (explicit map) or the first label (path format).
size	The width of this panel.

Example

        - cypher: github-org-repos
          caption: GitHub Repositories
          type: graph
          graph_settings:
            node_label: name
            node_color_by: group
          size: 12

markdown

To render markdown, use a markdown panel.

Standard Markdown is supported, including bold, italic, headings, ordered and unordered lists, links, code spans, fenced code blocks, and tables. Tables are rendered using MUI components with themed borders and a highlighted header row. Heading levels in the Markdown source are shifted down by one (## renders as <h3>, etc.) so they fit naturally within the panel hierarchy.

Field	Description
markdown	The markdown content to render. Supports headings, lists, links, code, and tables.
type	The type of panel. markdown, for this panel type.
size	The width of this panel.

Example

          - markdown: |-
              ## CVE info
              1. [CVE-2021-44228](https://security.snyk.io/vuln/SNYK-JAVA-ORGAPACHELOGGINGLOG4J-2314720): Remote Code Execution (RCE), affects log4j versions below 2.15.0
              1. [CVE-2021-4104](https://security.snyk.io/vuln/SNYK-JAVA-LOG4J-2316893): Arbitrary Code Execution, affects log4j 1.x
              1. [CVE-2021-45046](https://security.snyk.io/vuln/SNYK-JAVA-ORGAPACHELOGGINGLOG4J-2320014): Remote Code Execution (RCE), affects log4j versions below 2.16.0
              1. [CVE-2021-45105](https://security.snyk.io/vuln/SNYK-JAVA-ORGAPACHELOGGINGLOG4J-2321524): Denial of Service (DoS), affects log4j versions below 2.17.0
              1. [CVE-2021-44832](https://security.snyk.io/vuln/SNYK-JAVA-ORGAPACHELOGGINGLOG4J-2327339): Arbitrary Code Execution (RCE), affects log4j versions below 2.17.1

              ## Recommended action
              Upgrade to log4j 2.17.1 or higher.
            type: markdown
            size: 12

Named Queries

Reports can define a queries dict of named Cypher strings. Panel cypher and details_cypher fields are resolved against this dict at render time. If the field value is not a key in the dict, it is used as a literal Cypher string — allowing panels to embed queries directly without adding them to the queries dict first.

reports:
  dashboard:
    name: Dashboard
    queries:
      cves-total: |-
        MATCH (c:CVE)
        RETURN count(c.id) AS total
    rows:
      - name: Overview
        panels:
          # Named reference — resolved from the queries dict above
          - cypher: cves-total
            type: count
            caption: Total CVEs
            size: 3
          # Direct Cypher string — no entry in queries needed
          - cypher: |-
              MATCH (c:CVE)
              RETURN count(c.id) AS total
            type: count
            caption: Total CVEs (direct)
            size: 3

Inputs

Reports can define inputs that can be used to pass parameters into queries used in panels in the report. These will be rendered at the top of the report, in the order specified in the configuration.

autocomplete

An autocomplete input can be used to use results queried from the graph as inputs to panels. End-users can select through a dropdown list of the values, or can type to search/autocomplete a value.

Field	Description
input_id	An ID for this input, that can be referenced from the params section of a panel.
cypher	A cypher query used to return the relevant data. This is not a reference to a query, but the actual query to run. It’s recommended to use DISTINCT for the values returned. The query must return the data as value.
default	A dictionary with the default label and value for the input, when not set.
type	The type of input. autocomplete, for this input type.
size	The width of this input.

Example

      - input_id: cve-severity-autocomplete-input
        cypher: >-
          MATCH (c:CVE)
          RETURN DISTINCT c.base_severity AS value
        label: CVE Severity
        type: autocomplete
        size: 2

text

A text input can be used for user-defined input for panel query parameters. Panel re-renders are debounced: connected panels only update 300 ms after the user stops typing, rather than on every keystroke.

Field	Description
input_id	An ID for this input, that can be referenced from the params section of a panel.
default	A dictionary with the default value for the input, when not set.
type	The type of input. text, for this input type.
size	The width of this input.

Example

      - input_id: cve-id-regex
        label: Regex
        type: text
        size: 2

Example Configuration

All panel types with a cypher query have an info button that shows extra details about the panel, such as the query used, the parameters to the query, metrics that may be pushed with it, etc. For count, progress, pie, bar, graph, and vertical-table panels, the info button appears in the top-right corner of the panel and is only visible on hover. For table panels the info button is always visible, inline with the panel header. Non-table panel types that also have a details_cypher configured will show a data drill-down table as the first tab in the details view.

Example configuration

.. literalinclude:: ../../../.config/dev/seizu/reporting-dashboard.yaml :language: yaml