metabase.api.preview-embed
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:
- Require admin access
- Ignore the values of
:enabled_embeddingfor Cards/Dashboards - Ignore the
:embed_paramswhitelist for Card/Dashboards, instead using a field called:_embedding_paramsin 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.GET_card_:tokenclj
GET /api/preview-embed/card/:token
Fetch a Card you're considering embedding by passing a JWT TOKEN.
PARAMS:
token
## `GET /api/preview-embed/card/:token` Fetch a Card you're considering embedding by passing a JWT TOKEN. ##### PARAMS: * **`token`**
GET_card_:token_queryclj
GET /api/preview-embed/card/:token/query
Fetch the query results for a Card you're considering embedding by passing a JWT TOKEN.
PARAMS:
-
token -
& -
query-params
## `GET /api/preview-embed/card/:token/query` Fetch the query results for a Card you're considering embedding by passing a JWT TOKEN. ##### PARAMS: * **`token`** * **`&`** * **`query-params`**
GET_dashboard_:tokenclj
GET /api/preview-embed/dashboard/:token
Fetch a Dashboard you're considering embedding by passing a JWT TOKEN.
PARAMS:
token
## `GET /api/preview-embed/dashboard/:token` Fetch a Dashboard you're considering embedding by passing a JWT TOKEN. ##### PARAMS: * **`token`**
GET_dashboard_:token_dashcard_:dashcard-id_card_:card-idclj
GET /api/preview-embed/dashboard/:token/dashcard/:dashcard-id/card/:card-id
Fetch the results of running a Card belonging to a Dashboard you're considering embedding with JWT TOKEN.
PARAMS:
-
token -
dashcard-id -
card-id -
& -
query-params
## `GET /api/preview-embed/dashboard/:token/dashcard/:dashcard-id/card/:card-id` Fetch the results of running a Card belonging to a Dashboard you're considering embedding with JWT TOKEN. ##### PARAMS: * **`token`** * **`dashcard-id`** * **`card-id`** * **`&`** * **`query-params`**
routesclj
Ring routes for api/preview-embed: (GET_dashboard_:token GET_dashboard_:token_dashcard_:dashcard-id_card_:card-id GET_card_:token_query GET_card_:token)
Ring routes for api/preview-embed: (GET_dashboard_:token GET_dashboard_:token_dashcard_:dashcard-id_card_:card-id GET_card_:token_query GET_card_:token)
cljdoc is a website building & hosting documentation for Clojure/Script libraries
× close