Jinja Template - url_param not working

[j7282978-ops]

Hi all,

I’m trying to embed a Superset dashboard in a React app using the Superset SDK. I want to pass a parameter called survey_id via URL parameters and use it in my dataset query:

SELECT *
FROM table
WHERE id IN ({{ url_param('survey_id') | default(3) | int }})

However, the query always defaults to 3 and doesn’t filter based on the value I’m sending.

I’ve enabled the relevant feature flags in superset_config.py:

FEATURE_FLAGS = {
"ENABLE_TEMPLATE_PROCESSING": True,
"ALERT_REPORTS": True,
"EMBEDDED_SUPERSET": True
}

Here’s how I’m embedding the dashboard in React using embedDashboard:

const dashboardUiConfig = {
urlParams: {
survey_id: 6, // parameter to pass to Superset
...(permalinkKey ? { permalink_key: permalinkKey } : {}) // optional
},
filters: { expanded: false, visible: false }, // control filter visibility
hideTitle: true,
hideChartControls: true,
hideTab: true
};

// Example usage
embedDashboard({
id: DASHBOARD_ID,
supersetDomain: "http://localhost:8088",
mountPoint: document.getElementById("dashboard-container"),
dashboardUiConfig
});

Questions:

I want survey_id to be picked up by the dashboard query, but it always defaults to the default(3) value.

Is there anything else I need to configure to make url_param work in this embedded setup?

Any guidance or working examples would be greatly appreciated.

[dosubot[bot]]

Hi @j7282978-ops! I'm Dosu and I’m helping the superset team.

The most common reason url_param('survey_id') defaults to 3 in embedded dashboards is a breakdown in passing urlParams from the SDK to the backend. Superset expects these parameters in the url_params key of the form data, and the Jinja macro will use the default if it can't find the value in the request context or form data. Your feature flag placement looks correct—ENABLE_TEMPLATE_PROCESSING must be inside FEATURE_FLAGS for Jinja macros to work as expected in Superset 6.x source.

Make sure your embedding setup propagates urlParams correctly. The SDK usage should look like:

embedDashboard({
  id: DASHBOARD_ID,
  supersetDomain: "http://localhost:8088",
  mountPoint: document.getElementById("dashboard-container"),
  dashboardUiConfig: {
    urlParams: { survey_id: 6 },
    // other config...
  }
});

If you’re still seeing the default value, check for CORS/session issues, RBAC permissions for the embedded user, and confirm that the backend receives the expected url_params in the form data. Also, be aware of a known bug with async queries and multiple Jinja parameters in embedded dashboards—if you use more than one parameter, cache key mismatches can cause filtering to break source.

For dynamic filtering, you can also use the filter_values() Jinja function in your SQL query:

SELECT *
FROM table
WHERE id IN {{ filter_values('survey_id') | where_in }}

This approach is often more robust for dashboard filters source.

If you need a working example, the SDK and backend should pass urlParams as key-value pairs, and your Jinja query should reference them as shown above. If you’re still stuck, double-check the network requests to ensure survey_id is present in the payload sent to Superset.

To reply, just mention @dosu.

---

^{How did I do? Good | Irrelevant | Incorrect | Verbose | Hallucination | Report 🐛 | Other}    

[j7282978-ops]

@dosu
I tried to pass it like this through SDK
dashboardUiConfig: {
hideTitle: true,
hideChartControls: true,
hideTab: true,
filters: { expanded: false, visible: false },
urlParams: { id: 8 }
}

This is the query
sq2.survey_id in ({{ url_param('survey_id') | default(8) | int }})

This shows an error in the chart - "Error: Columns missing in dataset: "
I can see the survey_id in the payload in network requests.

Getting same error with filter_values.

[dosubot[bot]]

The error is likely because your SQL references sq2.survey_id, but Superset datasets require you to use the plain column name as defined in the dataset—usually just survey_id (not qualified or aliased) source. Also, your SDK config uses urlParams: { id: 8 }, but your Jinja macro expects survey_id. Both names must match for the parameter to be picked up source.

Try updating your query to:

survey_id IN ({{ url_param('survey_id') | default(8) | int }})

and your SDK config to:

urlParams: { survey_id: 8 }

If you use filter_values, the same column name rule applies.

If you still see missing columns, use an if/else in your SQL to ensure the query always returns results, like:

WHERE 1=1
{% if url_param('survey_id') %}
  AND survey_id = {{ url_param('survey_id') | int }}
{% else %}
  AND survey_id = 8
{% endif %}

This prevents empty result sets from causing column sync issues source.

If problems persist, check your dataset definition in Superset to confirm survey_id is present, and review logs for more details.

To reply, just mention @dosu.

---

^{How did I do? Good | Irrelevant | Incorrect | Verbose | Hallucination | Report 🐛 | Other}    

[j7282978-ops]

My bad.
I pasted it wrong here by mistake.

Survey_id is correctly used at both places still getting the error.

@dosu