How to Find the ID of a Dashboard or Visualisation for Embedding

To embed a dashboard or visualisation into your app using web or desktop components, you'll need its unique ID. This guide walks you through how to find it quickly using the platform UI.

➡️ Tip: To ensure users can view an embedded dashboard or visualisation, they must have the appropriate access. Make sure the object is not set to private, the target users have permission to access the category it’s published in, and they also have access to the underlying data sources used in the visualisation. 

Step-by-Step Instructions

1. Log In to Your Tenant

Start by signing into your tenant where the dashboards or visualisations are hosted.

2. Get the ID of a Visualisation

a. Open the Visualisation

Navigate to the visualisation you want to embed.

b. Click the Share Icon

Look for the Share icon (in the toolbar on the right), and click it.

c. Select "Embed"

From the sharing options, choose Embed.

d. Copy the Embed Code

The embed code will be shown. Inside it, you’ll see the visualisation ID (usually in the URL or as an attribute).

➡️ Tip: You can extract just the ID portion to use in your component or API.

3. Get the ID of a Dashboard

a. Open the Dashboard

Just like with a visualisation, navigate to the dashboard you want to embed.

b. Click the Share Icon

Click the Share button again.

c. Select "Embed"

Choose the Embed option.

d. Copy the Embed Code

You’ll now see the embed code for the dashboard. The dashboard ID is also visible in that code.

➡️ Tip: Use this ID with either the desktop or web components to embed the dashboard in your own applications.

✅ You're Done!

You now have the ID you need to embed your content into your app. Whether you're using web or desktop components, this ID will ensure the right content displays.