Dashboarding

Dashboards are visual representations of data. Squirro supports extensive dashboarding functions, allowing you to have real-time visual representations of data as you search.

Table of Contents

Creating dashboards

To create a dashboard, 

1. Open the Dashboard page by clicking on Dashboard in the top menu.
2. Click on the + sign at the end of the list of existing dashboards.
   
   
   
   
3. Alternatively, you can use the save button's dropdown to create a dashboard from the current search query.
   
   
   
   
4. Name your dashboard and provide an initial query (you can change both the name and the query later on). To include all documents, leave the query empty.
   
   
   
   
5. Press SAVE.

Editing dashboards

To enter editing mode,

1. Click the dashboard settings icon at the right upper corner of the dashboard,
   
   
   
    
2. Click on Edit Dashboard.

3. You are now in editing mode.

Change title and query of dashboard

To change your dashboard's main query or title,

1. Enter editing mode using the steps described above,

2. Enter the new title in the title field (1) and the new query in the search field (2).
   
   
   
   

3. Once done, press SAVE to save your changes or CANCEL to abandon them (3).

Widgets

Widgets are the building blocks of a dashboard. Each widget represents data in a particular form. Currently, Squirro offers a number of built-in widgets, such as pie charts, time frequency graphs (line charts) and word clouds.

Widget types

The available widget types are listed on the page Widgets.

Add widget

To add a widget,

1. Enter edit mode on the dashboard,
2. Click the dashboard settings button in the right upper corner of the dashboard,
3. Select Add widget from the dropdown.

Moving widgets

To move a widget,

1. Enter editing mode as described above,
2. Click on the handle in the middle of the top frame of the widget,
3. Drag widget using the handle.
   
   

Editing widgets

To edit a widget,

1. Enter editing mode as described above,
2. Click on the widget settings icon in the right upper corner of the widget's frame,
3. Select Edit from the dropdown menu.
   
   
    
4. Once you have made your changes, click Save to retain them or Cancel to revert to the widget's original settings.
   
   

Deleting widgets

To delete a widget,

1. Enter editing mode as described above,
2. Click on the widget settings icon in the right upper corner of the widget's frame,
3. Select Remove from the dropdown menu.
   
   

Embedding and Sharing Dashboards

To share or embed the current dashboard,

1. Click the Dashboard Setting Button and select "Share Dashboard" or "Embed iFrame"
   
   
   
   Both are technically the same, but the Embed iFrame offers an iframe HTML tag, instead of just a URL.

Dashboard URL API Reference

This API allows for easy integration into any web enabled 3rd party application.

Once you've collected the URL for your dashboard, the following URL parameters can be used to change the behavior of the dashboard.