/api/alert endpoints
/api/alert endpoints
/api/card endpoints.
/api/card endpoints.
/api/collection endpoints.
/api/collection endpoints.
Dynamic variables and utility functions/macros for writing API functions.
Dynamic variables and utility functions/macros for writing API functions.
Internal functions used by metabase.api.common
.
These are primarily used as the internal implementation of defendpoint
.
Internal functions used by `metabase.api.common`. These are primarily used as the internal implementation of `defendpoint`.
/api/dashboard endpoints.
/api/dashboard endpoints.
/api/database endpoints.
/api/database endpoints.
/api/dataset endpoints.
/api/dataset endpoints.
Various endpoints that use JSON web tokens to fetch Cards and Dashboards.
The endpoints are the same as the ones in api/public/
, and differ only in the way they are authorized.
To use these endpoints:
embedding-secret-key
Setting to a hexadecimal-encoded 32-byte sequence (i.e., a 64-character string).
You can use /api/util/random_token
to get a cryptographically-secure value for this.Tokens can have the following fields:
{:resource {:question <card-id> :dashboard <dashboard-id>} :params <params>}
Various endpoints that use [JSON web tokens](https://jwt.io/introduction/) to fetch Cards and Dashboards. The endpoints are the same as the ones in `api/public/`, and differ only in the way they are authorized. To use these endpoints: 1. Set the `embedding-secret-key` Setting to a hexadecimal-encoded 32-byte sequence (i.e., a 64-character string). You can use `/api/util/random_token` to get a cryptographically-secure value for this. 2. Sign/base-64 encode a JSON Web Token using the secret key and pass it as the relevant part of the URL path to the various endpoints here. Tokens can have the following fields: {:resource {:question <card-id> :dashboard <dashboard-id>} :params <params>}
/api/metric endpoints.
/api/metric endpoints.
/api/notify/* endpoints which receive inbound etl server notifications.
/api/notify/* endpoints which receive inbound etl server notifications.
/api/permissions endpoints.
/api/permissions endpoints.
Endpoints for previewing how Cards and Dashboards will look when embedding them.
These endpoints are basically identical in functionality to the ones in /api/embed
, but:
:enabled_embedding
for Cards/Dashboards:embed_params
whitelist for Card/Dashboards, instead using a field called :_embedding_params
in
the JWT token itself.Refer to the documentation for those endpoints for further details.
Endpoints for previewing how Cards and Dashboards will look when embedding them. These endpoints are basically identical in functionality to the ones in `/api/embed`, but: 1. Require admin access 2. Ignore the values of `:enabled_embedding` for Cards/Dashboards 3. Ignore the `:embed_params` whitelist for Card/Dashboards, instead using a field called `:_embedding_params` in the JWT token itself. Refer to the documentation for those endpoints for further details.
Metabase API endpoints for viewing publicly-accessible Cards and Dashboards.
Metabase API endpoints for viewing publicly-accessible Cards and Dashboards.
/api/pulse endpoints.
/api/pulse endpoints.
/api/segment endpoints.
/api/segment endpoints.
/api/session endpoints
/api/session endpoints
/api/setting endpoints
/api/setting endpoints
/api/table endpoints.
/api/table endpoints.
/api/tiles
endpoints.
`/api/tiles` endpoints.
/api/user endpoints
/api/user endpoints
Random utilty endpoints for things that don't belong anywhere else in particular, e.g. endpoints for certain admin page tasks.
Random utilty endpoints for things that don't belong anywhere else in particular, e.g. endpoints for certain admin page tasks.
cljdoc is a website building & hosting documentation for Clojure/Script libraries
× close