These are the docs for the Metabase master branch. Some features documented here may not yet be available in the latest release. Check out the docs for the latest version, Metabase v0.52.
Metabase API documentation
These reference files were generated from source comments by running:
clojure -M:ee:doc api-documentation
About the Metabase API
- The API is subject to change. We rarely change API endpoints, and almost never remove them, but if you write code that relies on the API, there’s a chance you might have to update your code in the future.
- The API isn’t versioned. So don’t expect to stay on a particular version of Metabase in order to use a “stable” API.
API tutorial
Check out an introduction to the Metabase API.
API keys
Create keys to authenticate programmatic requests to your Metabase. See API keys.
API changelog
For breaking changes, see the API changelog.
API endpoints
* indicates endpoints used for features available on paid plans.
- Action
- Activity
- Advanced config logs*
- Advanced permissions application*
- Advanced permissions impersonation*
- Alert
- API key
- Audit app user*
- Automagic dashboards
- Bookmark
- Cache
- Card
- Channel
- Cloud migration
- Collection
- Content verification review*
- Dashboard
- Database
- Dataset
- Embed
- Field
- GeoJSON
- LDAP
- LLM
- Login history
- Metabot
- Model index
- Native query snippet
- Notify
- Permissions
- Persist
- Premium features
- Preview embed
- Public
- Pulse
- Query reference validation*
- Revision
- Routes
- Sandbox GTAP*
- Sandbox table*
- Sandbox user*
- SCIM
- Search
- Segment
- Serialization*
- Session
- Setting
- Setup
- Slack
- SSO*
- SSO SAML
- Stale
- Table
- Task
- Tiles
- Timeline
- Timeline event
- Upload management*
- User
- Util
Read docs for other versions of Metabase.