Create Dashboard

This guide is designed to walk you through the process of creating a customized dashboard that will enable you to visualize and monitor key metrics that are relevant to your projects. Our intuitive dashboard creation tool provides you with a flexible and user-friendly interface to aggregate and display your data effectively.

Follow the steps outlined here to build a dashboard that helps you stay informed and make data-driven decisions with ease.

Using the UI

Guiding you through the intuitive user interface to help you set up and customize your dashboard effectively.

Step 1: Create Dashboard

Select the "Create Dashboard" option to establish a new dashboard where you will add and manage your widgets.

Step 2: Add Widgets

Integrate different widgets into your dashboard to display various data points and insights.

Add Widgets from the Dashboard Page

Select "Add Widget" while on the Dashboard page to quickly insert predefined widgets that can be configured to your needs.

Add Widgets from the Explore Page

Use the Explore page to investigate and create insightful queries. after doing that, you can add your query to any existing dashboard or create a new one.

Additional Actions to Perform:

Edit widget

Allows you to change your query or visualization and adjust the widget better for your need

Customize Your Dashboard Layout

Take control! Drag and drop widgets, or resize them to create an efficient and personalized view of your data.

Expand Widget View

Click on any widget to enlarge it for a detailed examination of the data presented, facilitating a deeper analysis within the same dashboard interface.

Refresh Button:

Keep all your information up-to-date with a simple click using the new refresh button that updates all widgets on your dashboard at once.

Using the SDK

📘

Prerequisites

To install and properly configure the SWE SDK, please visit the SDK guide.

Step 1: Create Dashboard

Establish a new dashboard where you will add and manage your widgets

dashboard_response = sw.dashboard.create(name="My Cool Dashboard")

Step 2: Add Widgets

Widgets are queries and visualizations presented on a dashboard. A query can be built either on top of a dataset or on top of events. In order to create a widget (and associated query) using a dataset, you must first create the dataset. For more information on creating a dataset, please refer to creating a dataset.

from superwise_api.models.dashboard_item.dashboard_item import Query, Datasource, QueryType, VisualizationType

dashboard_item_response = sw.dashboard_item.create(
  	name="My Cool Widget",
    dashboard_id=dashboard_response.id,
    query_type=QueryType.STATISTICS,
    visualization_type=VisualizationType.BAR_PLOT,
    datasource=Datasource.DATASETS,
    query=Query(measures=[f"{dataset.internal_id}.count"], dimensions=[f"{dataset.internal_id}.country"]), item_metadata={})

📘

Optional QueryType

• RAW_DATA
• STATISTICS
• TIME_SERIES
• DISTRIBUTION

📘

Optional VisualizationType

• TABLE
• LINE_GRAPH
• BAR_PLOT
• TIME_SERIES
• HISTOGRAM

📘

Optional Datasource

• DATASETS
• EVENTS