Query Regarding Adding Parameters in Superset Dashboards and Embedded Reports

[ishirvani]

Dear Superset Team,

I hope this message finds you well. I am currently working on a project where I need to define and use parameters within a Superset dashboard. However, I am unable to find the option to add parameters directly in the dashboard interface.

Additionally, I would like to know if it is possible to apply these parameters to embedded reports, allowing for filterable reports based on these parameters.

Could you please provide guidance or share any documentation on how to achieve this? Are there any workarounds or specific steps that I need to follow to implement parameters in Superset dashboards and embedded reports?

Thank you in advance for your assistance. I look forward to your response.

Best regards, iman

[dosubot[bot]]

To implement parameters in Superset dashboards, you can use URL parameters. You can define default values for these parameters in the chart metadata by adding a key-value pair like url_params: {'foo': 'bar'}. This allows you to pass parameters in the explore view and from the dashboard, which will carry through to your queries ^[1].

For embedded reports, you can use the Superset Embedded SDK. This SDK allows you to embed dashboards with parameters using JavaScript. Here's a brief overview of how you can achieve this:

1. Install the SDK using npm:

   npm install --save @superset-ui/embedded-sdk

2. Use the embedDashboard function to embed a dashboard with parameters:

   import { embedDashboard } from "@superset-ui/embedded-sdk";
   
   embedDashboard({
     id: "abc123", // given by the Superset embedding UI
     supersetDomain: "https://superset.example.com",
     mountPoint: document.getElementById("my-superset-container"),
     fetchGuestToken: () => fetchGuestTokenFromBackend(),
     dashboardUiConfig: {
         hideTitle: true,
         filters: {
             expanded: true,
         },
         urlParams: {
             foo: 'value1',
             bar: 'value2',
         }
     },
     iframeSandboxExtras: ['allow-top-navigation', 'allow-popups-to-escape-sandbox']
   });

This setup allows you to customize the embedded dashboard by passing parameters such as dashboardUiConfig and urlParams, which can be used to control the visibility of UI elements and pass additional parameters to the dashboard ^[2].

To continue talking to Dosu, mention @dosu.

---

^{Help Dosu learn! Give it feedback: Great Response | Irrelevant Answer | Incorrect Sources | Too Verbose | Hallucination | Bug Report | Other}

[ishirvani]

Dear Superset Team,

I hope this message finds you well. I am currently working on a project where I need to define and use parameters within a Superset dashboard. However, I am unable to find the option to add parameters directly in the dashboard interface.

To implement parameters in Superset dashboards, I understand that I can use URL parameters. You can define default values for these parameters in the chart metadata by adding a key-value pair like url_params: {'foo': 'bar'}. This allows you to pass parameters in the explore view and from the dashboard, which will carry through to your queries.

For embedded reports, I can use the Superset Embedded SDK. This SDK allows embedding dashboards with parameters using JavaScript.

Additionally, I would like to request a more user-friendly approach where users (not just project admins) can define these parameters while creating dashboards and have them transferred to the embedded reports, similar to the functionality in SSRS.

Could you please provide guidance or share any documentation on how to achieve this? Are there any workarounds or specific steps that I need to follow to implement user-friendly parameters in Superset dashboards and embedded reports?

Thank you in advance for your assistance. I look forward to your response.

Best regards,iman