# Dashboard Apps

> **📝 Note**: This is a Preview feature.

SingleStore Dashboard Apps enables users to create, publish, and manage real-time interactive dashboards through the Cloud Portal. It integrates with SingleStore Notebooks and uses Plotly's Dash framework. It helps in monitoring key metrics, exploring trends, and making data-driven decisions in real time.

Create and manage dashboard apps using the Cloud Portal.

## Publish Dashboard Apps using the Cloud Portal

## Create a Dashboard App

Dashboard Apps can be created for shared notebooks only. Create a dashboard app using one of the following methods:

1. Navigate to **Dashboards** in the left navigation and select **Get Started**.

2. Navigate to **Editor > Shared**.

   1. Select a shared notebook.

   2. Select **Publish** (on the top right).

## New Dashboard App

After selecting **Publish**, enter or select the following in **Publish Settings**.

| **Publish Settings** |                                                                                                                                                                                                                         |
| -------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Publish as**       | Select**Dashboard**.                                                                                                                                                                                                    |
| **Name**             | Enter a name of the dashboard app.                                                                                                                                                                                      |
| **Description**      | Enter the dashboard app description.                                                                                                                                                                                    |
| **Notebook**         | Select a shared notebook to publish as a dashboard app. The shared notebook is pre-selected when the dashboard app is published through notebooks.                                                                      |
| **Workspace**        | Select theSingleStoreworkspacethe notebook connects to.Selecting aworkspaceallows connecting to theSingleStoredatabases referenced in the notebook natively. A dashboard app can be published without a attached to it. |
| **Runtime**          | Select a runtime from the following:<ul> <li>Small</li> <li>Medium</li> <li>GPU-T4</li> </ul><blockquote> <p><strong>📝 Note</strong>: <p>This field is in preview.</p></p> </blockquote>                               |
| **Region**           | Select a region.                                                                                                                                                                                                        |
| **Idle Timeout**     | Select an idle timeout.<blockquote> <p><strong>📝 Note</strong>: <p>This field is in preview.</p></p> </blockquote>                                                                                                     |

Select **Next**, review the **Summary**, and select **Publish** to publish the notebook as a dashboard app.

## Example Notebook

The following notebook shows how to publish your first dashboard app.

## Manage an Existing Dashboard App

To view an existing dashboard app, select **Dashboards** in the left navigation. Existing dashboard App can be managed by performing the following actions:

* View
* Update
* Share
* Delete

## View an Existing Dashboard App

To view an existing dashboard app, select the dashboard app name under the **Name** column and view the details for each dashboard app.

View the details of a dashboard app on the right navigation. Following actions can be performed for a dashboard app from this page:

* View Dashboard in New Tab
* View API Keys
* View Live Logs
* Share
* Update
* Delete

## View API Keys

Refer to [Container App API Keys](https://docs.singlestore.com/cloud/container-services/container-app-api-keys.md) for related information.

## View Live Logs

To view live logs of the selected dashboard app, select **View Live Logs** from the ellipsis on the right side. A new window appears, where the **Timestamp** and the message in the **Body** column can be viewed. View the **Log JSON** by selecting the eye icon.

## Update an Existing Dashboard App

To update an existing dashboard app, select the ellipsis in the **Actions** column of the dashboard app, and select **Update**.

A dashboard app can also be updated using the shared notebook. Select **Update Dashboard** and select **Update**.

## Share an Existing Dashboard App

To share an existing dashboard app, select the ellipsis in the **Actions** column of the dashboard app, and select **Share**

## Delete an Existing Dashboard App

To delete an existing dashboard app, select the ellipsis in the **Actions** column of the dashboard app, and select **Delete**.

## Status of Dashboard Apps

| **Status**   | **Description**                                                                                                                                                                        |
| ------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Initializing | The notebook is creating or updating the dashboard.                                                                                                                                    |
| Active       | The dashboard is configured correctly. The notebook is successfully published as a dashboard.                                                                                          |
| Failed       | The dashboard is not configured correctly. View the notebook snapshot to debug the failure.                                                                                            |
| Error        | An error unrelated to the notebook code prevented the dashboard from initializing. Refer to[Troubleshoot Dashboard Apps](https://docs.singlestore.com/#section-idm234663965101069.md). |

## Troubleshoot Dashboard Apps

SingleStore automatically saves a snapshot of the notebook for each execution that fails. Navigate to **Apps** in the left navigation, select the dashboard, and download the snapshot associated with the failed dashboard to diagnose the error.

| **Error**                    | **Solution**                                                                                                |
| ---------------------------- | ----------------------------------------------------------------------------------------------------------- |
| WorkspaceDeleted             | Update the dashboard and select aworkspace.                                                                 |
| WorkspaceSuspended           | Resume theworkspaceor create a new dashboard with a differentworkspace.                                     |
| Database Detached            | Reattach the database with the right permissions or create a new dashboard with a different database.       |
| Notebook Deleted/Not Present | Create a new dashboard with a different notebook.                                                           |
| Internal Errors/Misc         | Reach out to[SingleStoreSupport](http://support.singlestore.com)or use the chat feature in theCloud Portal. |

***

Modified at: July 7, 2026

Source: [/cloud/container-services/dashboard-apps/](https://docs.singlestore.com/cloud/container-services/dashboard-apps/)

(An index of the documentation is available at /llms.txt)
