Liking cljdoc? Tell your friends :D

metabase.api.common.internal

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`.
raw docstring

metabase.api.email

/api/email endpoints

/api/email endpoints
raw docstring

metabase.api.embed

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:

  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>}

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>}
raw docstring

metabase.api.ldap

/api/ldap endpoints

/api/ldap endpoints
raw docstring

metabase.api.notify

/api/notify/* endpoints which receive inbound etl server notifications.

/api/notify/* endpoints which receive inbound etl server notifications.
raw docstring

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:

  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.

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.
raw docstring

metabase.api.setting

/api/setting endpoints

/api/setting endpoints
raw docstring

metabase.api.slack

/api/slack endpoints

/api/slack endpoints
raw docstring

metabase.api.task

/api/task endpoints

/api/task endpoints
raw docstring

metabase.api.util

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.
raw docstring

cljdoc is a website building & hosting documentation for Clojure/Script libraries

× close