adding custom api

[srijani-smsrc]

i need to add another button in the menu download as csv , download as pivot , downloas as image , custom download ,
this button will call a endpoint (where should I write this) and the endpoint will go to a python file which will do something

@dosubot

[dosubot[bot]]

There's no plugin system for adding a download menu item purely from config — it requires touching both the frontend menu code and the backend API. Here's the concrete path based on how the existing download items are built:

1. Add the menu item (frontend)

The chart's dropdown menu on a dashboard is defined in SliceHeaderControls/index.tsx. The download entries live inside a Menu.SubMenu title={t('Download')} block, which includes items like ExportCsv, ExportXlsx, and DownloadAsImage [1]. To add your custom button:

• Add a new value to the MenuKeys enum (imported from src/dashboard/types [2]).
• Add a new <Menu.Item key={MenuKeys.MyCustomDownload}> inside that Download submenu.
• Handle the click in the existing handleMenuClick switch statement — each case calls a prop callback, e.g. case MenuKeys.ExportCsv: props.exportCSV?.(props.slice.slice_id); [3]. You'd add your own case that fires an HTTP request (via Superset's SupersetClient) to your new endpoint.

2. Where to put the new endpoint (backend)

Superset's REST APIs are Flask-AppBuilder BaseSupersetModelRestApi classes. For example, ChartRestApi defines custom actions as methods decorated with @expose("/<pk>/my_action/", methods=("POST",)), @protect(), @safe — you can see this pattern on the cache_screenshot, screenshot, thumbnail, and export endpoints [4]. You have two options:

• Modify an existing API class (like ChartRestApi) if your logic is chart-related. This inherits existing auth/permissions but requires maintaining a fork or upstreaming the change.

• Register your own Blueprint/API via config without touching Superset core. You can use the FLASK_APP_MUTATOR hook in superset_config.py, which receives the Flask app object at startup and lets you attach arbitrary routes [5]. Alternatively, superset/config.py also has a BLUEPRINTS config key that accepts a list of Flask Blueprint objects to be registered at startup [6]. Either approach lets you define your endpoint in a separate Python file and point it to whatever logic you need.

In summary: add a MenuKeys entry + Menu.Item + handleMenuClick case in SliceHeaderControls/index.tsx that calls your endpoint; write that endpoint either as a new method on an existing *RestApi class or as your own Flask Blueprint registered via BLUEPRINTS or FLASK_APP_MUTATOR in superset_config.py; the endpoint itself just imports and calls whatever Python module does the actual work.

Want me to dig into the exact MenuKeys/type definitions or how SupersetClient is typically used to call a custom endpoint from that menu item?

To reply, just mention @dosu.

---

Share context across your team and agents. Try Dosu.