Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  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 
    Status
    colourBlue
    titleSave
    .
  6. Directly after creation, you are presented with a fresh dashboard, an empty widget and a configuration panel for it.

    Image Added

  7. Continue with the next sections to learn how to configure the newly created dashboard.

Editing dashboards

To enter editing mode,

  1. Click on the dashboard settings pencil icon at in the top right upper corner of the dashboard,:
    Image Removed
     
  2. Click on Edit Dashboard.

  3. Image Added

  4. You are now in editing mode.

...

  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).
    Image RemovedIn the edit sidebar to the right, open the Dashboard section

    Image Added

  3. Enter the title and query as desired.

  4. Once done, press  

    Status
    colourBlue
    titleSave
    the Save Changes button at the top to save your changes or 
    Status
    titleCancel
    or press 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.

...

  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.
  4. In the edit pane on the right, press the plus button next to the "Widgets" header.

    Image Added

  5. Set a title and the widget type to use in this form.

    Image Added

    See the Widgets documentation for information about the various widget types.

  6. Depending on the widget type, additional configuration options may be displayed and required.
  7. Changes made in this form are applied immediately to the dashboard, but not yet saved.
  8. To save the changes, use the Save Dashboard button at the top of the edit sidebar.

    Image Added

Moving widgets

To move a widget,

...

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

    Image Added
     
  3. The widget is activated in the edit panel on the right side of the screen.

    Image Added

  4. Changes made in this form are applied immediately to the dashboard, but not yet saved.
  5. To save the changes, use the Save Dashboard button at the top of the edit sidebar.

    Image Added

Deleting widgets

...

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

    Image Added

  3. Confirm the deletion in the resulting dialog.

    Image Added

Embedding and Sharing Dashboards

...

  1. Click the Dashboard Setting Button and select "Share Dashboard" or "Embed iFrame"


    Both are technically the same, but the
    The Embed iFrame offers an iframe HTML tag, instead of just a URLwhich can be used for embedding the dashboard in a 3rd-party web site or application. The Share Dashboard option offers a URL, which can be easily shared via email or other means.

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 The URL which is generated by the Embed and Share options in the dashboard can be extended with additional options. The following URL parameters can be used to change the behavior of the dashboard.

ParameterDescriptionExample Value
queryOverride the Dashboards search query&query=(blue OR green OR red)
selectionSet the Foreground query for all Significant Terms widgets&selection=blue
created_beforeOnly display results with a created_at value lower than this

&created_after=2012-12-31
&created_after=2012-12-31T18:30:00

created_afterOnly display results wit ha with a created_at value higher than this&created_before=2014-12-31
&created_before=2014-12-31T18:30:00
relative_startOnly display results with a created_at value higher than this, in relative terms to today

&relative_start=2y
&relative_start=8w

relative_endOnly display results with a created_at value lower than this, in relative terms to today&relative_end=1y
&relative_end=4w