Is there a supported way to deeplink to a dashboard with pre-applied filters from an external tool?

[anandita0102]

I'm integrating an external tool (Retool) with Apache Superset.
The goal is : when a user clicks a button in Retool, it should open a specific Superset dashboard with filters already applied (e.g. filter by a specific job ID and date).

Is there an officially supported way to do this? Ideally something like a URL that accepts filter values as parameters and opens the dashboard with those filters pre-applied-similar to a deeplink.

I looked into native_filters_key in the dashboard URL but couldn't find a public API or documented approach for generating that key programmatically from outside Superset.

Any guidance on the recommended approach would be appreciated.@dosu

[dingminghbut]

Yes, there is a supported path, but I would avoid trying to synthesize native_filters_key yourself. Treat that value as a server-generated state key.

The approach I would use from an external app like Retool is:

1. Build the desired native filter state for the dashboard, using the dashboard's native filter IDs/configuration.
2. Send that state to Superset through the dashboard filter state or dashboard permalink API.
3. Use the returned key/URL when opening the dashboard from Retool.

The relevant Superset APIs are:

• Dashboard filter state: POST /api/v1/dashboard/{pk}/filter_state
• Dashboard permanent link: POST /api/v1/dashboard/{pk}/permalink

So the external tool should call Superset's API first, receive the generated key, then open the dashboard with that generated state applied. For embedded dashboards, the same idea applies: pass the generated permalink key through the embedded SDK URL params rather than hand-building the native filter URL.

Docs:

• https://superset.apache.org/developer-docs/api/#dashboard-filter-state
• https://superset.apache.org/developer-docs/api/create-a-new-dashboards-permanent-link/
• https://superset.apache.org/user-docs/using-superset/embedding/#resolvepermalinkurl

[anandita0102]

@dingminghbut That's really helpful. Thanks

[dosubot[bot]]

There are a few supported approaches for deeplinking to a Superset dashboard with pre-applied filters from an external tool like Retool:

1. Rison-Encoded URL Filters (Newest approach)

As of a recent merge, Superset supports passing filters directly in the URL using Rison encoding [1]:

https://your-superset/superset/dashboard/<id>/?f=(job_id:12345,date:2024-01-15)

This matches filters by column name (case-insensitive, whitespace-tolerant) and auto-applies them. Unmatched filters are displayed as removable chips. This is likely the simplest option for your use case since you just need to construct the URL in Retool.

2. Dashboard Permalink API (Best for persistent/shareable links)

You can programmatically create a permalink that encodes the full filter state:

• POST /api/v1/dashboard/<dashboard_id>/permalink with a body containing dataMask (the native filter state), activeTabs, and urlParams [2] [3]
• The response gives you a key, and the dashboard URL becomes: https://your-superset/superset/dashboard/p/<key>/

The dataMask structure maps filter IDs to their filterState and extraFormData values. The challenge here is that you need to know the native filter IDs (which are UUIDs internal to the dashboard JSON).

3. Filter State API (Temporary/session-based)

There's also a temporary filter state API at api/v1/dashboard/{dashboard_id}/filter_state that lets you POST filter values and get a key back — this is what native_filters_key references [4]. However, this state is cached temporarily rather than permanently stored.

---

For your Retool integration, the Rison-encoded URL approach (#1) is probably the easiest — you just build the URL string with your job ID and date as parameters. If you need more durable links or complex filter states, the Permalink API (#2) would work but requires an API call to Superset first.

Note that the Rison URL filter feature is quite new, so make sure your Superset version includes it. If you're on an older version, the Permalink API is your best bet.

To reply, just mention @dosu.

---

Share context across your team and agents. Try Dosu.

[anandita0102]

Thanks, tried the Rison URL approach first but it didn't work for my setup. Proceeded with the filter state API - works perfectly.