Public APIs
Apache Superset favicon

Apache Superset

Business

API to manage your BI dashboards and data sources on Superset.

Apache Superset's website screenshot

About Apache Superset

Apache Superset provides a REST API following the OpenAPI specification for programmatic interaction with the platform, covering automation, integrations, and custom application development. Authentication is handled through JWT tokens, with endpoints for login, token refresh, CSRF tokens, and guest tokens.

The API exposes core resources for managing dashboards, charts, datasets, and database connections, along with data exploration tools including SQL Lab query execution and query history. It supports organizational features such as tagging, annotation layers, and CSS templates, as well as sharing and embedding through permanent links and embedded dashboard configuration.

Additional functionality includes scheduled reports and alerts, row-level security rules, role and permission management, user account administration, audit logging, cache management, and asset import/export. The API is intended for developers building automation or integrations against a Superset instance, or embedding its dashboards and charts into other applications.

Key features

  • Comprehensive REST API following the OpenAPI specification with cURL, Python, and JavaScript code samples
  • JWT token-based authentication with login and refresh endpoints
  • CRUD endpoints for dashboards, charts, datasets, and database connections
  • SQL Lab endpoints to execute SQL queries and manage query history
  • Row-level security and role/permission management endpoints
  • Import/export endpoints for Superset assets and embedded dashboard configuration

Frequently asked questions

Does Superset's API require authentication?

Yes, most API endpoints require a JWT access token obtained via the /api/v1/security/login endpoint.

What resources can be managed through the API?

The API covers dashboards, charts, datasets, database connections, SQL Lab queries, tags, annotation layers, and more.

Are there code samples for the API?

Yes, each endpoint includes ready-to-use code samples in cURL, Python, and JavaScript.

Can I embed or share dashboards using the API?

Yes, there are endpoints for embedded dashboard configuration and permanent links to dashboard, explore, and SQL Lab states.

Does Superset support row-level security?

Yes, the API includes Row Level Security endpoints to manage row-level access rules for data.

Advertise here

Featured products

  • SerpApi - Search API favicon
  • Screenshot Scout favicon
  • TalorData favicon
  • CoreClaw favicon

Show your product to thousands of developers

· 100k monthly pageviews
· 7k newsletter subscribers

Advertise your product