Documentation
Dashboard

Widgets

Build a dashboard widget from a SQL query and a chart type.

Create Widget opens a two-step wizard: Query, then Chart.

Query

FieldPurpose
TitleLabel on the widget.
TablePlatform table the query reads. Choosing a table fills schema help.
SchemaColumns on the selected table.
Runtime variablesPlaceholders substituted at run time. user_id is available as {{ user_id }}.
Preview user idUser id used when you click Run.
SQL QueryStatement to execute.
RunExecutes the SQL and fills Results Preview.

Example:

SELECT COUNT(*) AS n FROM cases WHERE created_by_id = {{ user_id }}

Widgets can query case, task, finding, evidence, file, package, parser, enricher, feed, document, user, role, workflow, processing, lookup, dashboard, custom field, SMTP, and API key tables. Pick the table in the wizard to see its columns.

Chart

Click Next. Choose how the preview rows are drawn (metric, table, or chart) and save the widget. Return to the dashboard and click Refresh.

Dashboard widgets use SQL and {{ user_id }}. List pages, enricher queries, and rule conditions use the JSON filter spec in Filter queries.

On this page