Dashboards
A dashboard arranges saved visualizations in a grid so that a security team can see the state of its environment at a glance.
Screen Layout
The dashboard screen has three areas.
- Dashboard selector for switching between existing dashboards.
- Grid area where widgets are placed by drag and drop.
- Toolbar with controls for creating, saving, exporting, and producing PDF output.
Dashboard Operations
Create a New Dashboard
- Click New Dashboard.
- Enter a dashboard name.
- An empty grid appears.
Add Widgets
- Click Add Widget.
- Select a saved visualization, created on the Search screen.
- The widget is placed on the grid.
Edit Layout
Three actions change the layout.
- Drag moves a widget to a new position.
- Resize changes a widget's dimensions by dragging its edges.
- Delete removes a widget through the
xbutton on it.
Save
Layout changes are not saved automatically. Click Save to persist them.
Grid Layout System
A dashboard uses a 12-column grid. Each widget is positioned with four parameters.
| Parameter | Description |
|---|---|
x |
Horizontal position (column, 0-11) |
y |
Vertical position (row) |
w |
Width (number of columns, max 12) |
h |
Height (number of rows) |
Layout Example
+------+------+
| viz1 | viz2 | x=0,w=6 x=6,w=6 y=0, h=4
| w=6 | w=6 |
+------+------+
| viz3 | x=0, w=12, y=4, h=3
| w=12 |
+-------------+
Layout JSON
{
"visualizations": [
{
"attributes": "viz-001",
"layout": {"x": 0, "y": 0, "w": 6, "h": 4}
},
{
"attributes": "viz-002",
"layout": {"x": 6, "y": 0, "w": 6, "h": 4}
},
{
"attributes": "viz-003",
"layout": {"x": 0, "y": 4, "w": 12, "h": 3}
}
]
}
Widget Types
Dashboards support the following chart types.
| Type | Use Case |
|---|---|
| Timeline | Time-series data trends |
| Bar Chart | Category comparison |
| Line Chart | Trend visualization |
| Pie Chart | Proportional display |
| Doughnut | Proportional display (ring style) |
| Polar Area | Radial comparison |
| Radar | Multi-axis comparison |
| Markdown | Text annotations and notes |
| Table | Tabular data display |
Time Range Override
Set a single time range at the dashboard level to apply it to every widget. This overrides each widget's individual time setting.
PDF Export
A dashboard can be exported as a PDF report for sharing and compliance documentation.
PDF Configuration Options
| Setting | Description |
|---|---|
| Cover Page | Title page with logo and report title |
| Page Layout | Portrait or landscape orientation |
| Chart Size | Output size of each chart |
| Footer Text | Custom text for page footers |
Export Steps
- Click PDF Export on the dashboard toolbar.
- Adjust the PDF settings (cover page, layout, footer).
- Click Generate to download the PDF.
JSON Import and Export
A dashboard configuration can be exported as a JSON file and imported into another environment to replicate it.
Export Format
{
"name": "Security Overview",
"visualizations": [
{
"title": "Firewall Deny Events",
"query": "from `firewall_logs` filter action == \"DENY\"",
"chartType": "timeline",
"layout": {"x": 0, "y": 0, "w": 6, "h": 4}
},
{
"title": "Top Blocked IPs",
"query": "from `firewall_logs` filter action == \"DENY\" group {src_ip} (aggregate {count = count this}) sort {-count} take 10",
"chartType": "bar",
"layout": {"x": 6, "y": 0, "w": 6, "h": 4}
}
]
}
Import
- Click Import on the dashboard toolbar.
- Select a JSON file.
- The dashboard and all of its widgets are recreated.
Cross-Organization Dashboards
An administrator with the appropriate permissions can use the organization selector to view dashboards that belong to another organization. This requires SharedAccess permissions to be configured between the two organizations.
API Operations
Dashboards can also be managed through the REST API. See the API Reference for full endpoint documentation, including the following.
GET /api/user/<user_id>/dashboard/lists dashboards.POST /api/user/<user_id>/dashboard/creates a dashboard.GET /api/user/<user_id>/visualize/lists saved visualizations.POST /api/user/<user_id>/visualize/creates a visualization.