Skip to main content

Superset

Integrate Apache Superset with Catalog to sync dashboards, charts, and related metadata. You can use Catalog-managed credentials or prepare uploads yourself using the BI Importer format. Catalog-managed Superset sync is still maturing; this page describes prerequisites, credential JSON, how Superset objects map today, and where to extend payloads when your ingestion includes more than charts and dashboards.

Requirements​

You need to be a Superset Admin for the Superset deployment you connect to Catalog. Admin access is required so Catalog can read metadata across your Superset deployment that standard viewer roles cannot reach.

Catalog Managed​

Use this section when Catalog stores your Superset credentials and runs scheduled sync for your Workspace.

Integration in progress

Catalog-managed Superset onboarding is still maturing. The admin requirement above applies to both Catalog-managed sync and any manual Superset steps you run yourself. If you need a fully self-run pipeline today, use Client Managed with BI Importer.

Provide Catalog with Superset connection details in this JSON shape:

{
    "host_url": "<Superset Host URL>",
    "username": "<Superset admin username>",
    "password": "<Superset admin password>"
}

host_url should be the root URL analysts use to open Superset in a browser. Include https:// in the value and adjust for reverse proxies or custom ports exactly as your network exposes Superset.

Enter credentials directly in Catalog.

For your first sync, allow up to 48 hours. Catalog notifies you when the initial sync completes.

If you prefer not to share credentials with Catalog operations, continue to Client Managed.

Client Managed​

Doing a One-Time Extract​

For a trial or one-time snapshot, assemble Superset metadata into BI Importer expected format, then upload using the channel your Catalog contact provides.

The Catalog extractor package published on PyPI includes dedicated command-line entry points for several BI platforms. There is not yet a published castor-extract-superset command in that package. Until an Apache Superset-specific command ships, rely on BI Importer formatting and upload flows. You can use the shared Google Colab notebook to explore extraction patterns for other tools while you build Superset exports manually or with custom scripts.

Superset to Catalog Translation​

These mappings reflect what Catalog documents today for Superset ingestion:

  • Chart - Tile
  • Dashboard - Dashboard

Superset also contains data sets, databases, SQL Lab saved queries, security roles, and row-level security objects. Those objects appear in Catalog only when your connector or BI Importer payload includes them and Catalog ingestion supports that shape for your tenant. When you expand beyond charts and dashboards, work with your Catalog contact to confirm which Superset objects are in scope for your project.

Common Issues​

If sync fails or dashboards look incomplete in Catalog, start with these checks:

  • 403 responses during sync - Confirm the account is still an Admin and that Superset did not expire the password or API-enabled policy you rely on.
  • Missing charts on dashboards - Chart-level permissions or data source access might block the service account even when dashboards list correctly for admins.

What's Next?​

  • Browse related setup patterns on BI Tools.
  • Review file layout and columns for uploads in BI Importer.