Liking cljdoc? Tell your friends :D
Clojure only.

metabase.api.public

Metabase API endpoints for viewing publicly-accessible Cards and Dashboards.

Metabase API endpoints for viewing publicly-accessible Cards and Dashboards.
raw docstring

card-and-field-id->valuesclj

(card-and-field-id->values card-id field-id)

Return the FieldValues for a Field with field-id that is referenced by Card with card-id.

Return the FieldValues for a Field with `field-id` that is referenced by Card with `card-id`.
sourceraw docstring

card-field-remapped-valuesclj

(card-field-remapped-values card-id field-id remapped-field-id value-str)

Return the reampped Field values for a Field referenced by a Card. This explanation is almost useless, so see the one in metabase.api.field/remapped-value if you would actually like to understand what is going on here.

Return the reampped Field values for a Field referenced by a *Card*. This explanation is almost useless, so see the
one in `metabase.api.field/remapped-value` if you would actually like to understand what is going on here.
sourceraw docstring

dashboard-and-field-id->valuesclj

(dashboard-and-field-id->values dashboard-id field-id)

Return the FieldValues for a Field with field-id that is referenced by Card with card-id which itself is present in Dashboard with dashboard-id.

Return the FieldValues for a Field with `field-id` that is referenced by Card with `card-id` which itself is present
in Dashboard with `dashboard-id`.
sourceraw docstring

dashboard-field-remapped-valuesclj

(dashboard-field-remapped-values dashboard-id
                                 field-id
                                 remapped-field-id
                                 value-str)

Return the reampped Field values for a Field referenced by a Dashboard. This explanation is almost useless, so see the one in metabase.api.field/remapped-value if you would actually like to understand what is going on here.

Return the reampped Field values for a Field referenced by a *Dashboard*. This explanation is almost useless, so see
the one in `metabase.api.field/remapped-value` if you would actually like to understand what is going on here.
sourceraw docstring

GET_card_:uuidclj

GET /api/public/card/:uuid

Fetch a publicly-accessible Card an return query results as well as :card information. Does not require auth credentials. Public sharing must be enabled.

PARAMS:
  • uuid
## `GET /api/public/card/:uuid`

Fetch a publicly-accessible Card an return query results as well as `:card` information. Does not require auth
   credentials. Public sharing must be enabled.

##### PARAMS:

*  **`uuid`**
sourceraw docstring

GET_card_:uuid_field_:field-id_remapping_:remapped-idclj

GET /api/public/card/:uuid/field/:field-id/remapping/:remapped-id

Fetch remapped Field values. This is the same as GET /api/field/:id/remapping/:remapped-id, but for use with public Cards.

PARAMS:

  • uuid

  • field-id

  • remapped-id

  • value value must be a non-blank string.

## `GET /api/public/card/:uuid/field/:field-id/remapping/:remapped-id`

Fetch remapped Field values. This is the same as `GET /api/field/:id/remapping/:remapped-id`, but for use with public
  Cards.

##### PARAMS:

*  **`uuid`** 

*  **`field-id`** 

*  **`remapped-id`** 

*  **`value`** value must be a non-blank string.
sourceraw docstring

GET_card_:uuid_field_:field-id_search_:search-field-idclj

GET /api/public/card/:uuid/field/:field-id/search/:search-field-id

Search for values of a Field that is referenced by a public Card.

PARAMS:

  • uuid

  • field-id

  • search-field-id

  • value value must be a non-blank string.

  • limit value may be nil, or if non-nil, value must be a valid integer greater than zero.

## `GET /api/public/card/:uuid/field/:field-id/search/:search-field-id`

Search for values of a Field that is referenced by a public Card.

##### PARAMS:

*  **`uuid`** 

*  **`field-id`** 

*  **`search-field-id`** 

*  **`value`** value must be a non-blank string.

*  **`limit`** value may be nil, or if non-nil, value must be a valid integer greater than zero.
sourceraw docstring

GET_card_:uuid_field_:field-id_valuesclj

GET /api/public/card/:uuid/field/:field-id/values

Fetch FieldValues for a Field that is referenced by a public Card.

PARAMS:

  • uuid

  • field-id

## `GET /api/public/card/:uuid/field/:field-id/values`

Fetch FieldValues for a Field that is referenced by a public Card.

##### PARAMS:

*  **`uuid`** 

*  **`field-id`**
sourceraw docstring

GET_card_:uuid_queryclj

GET /api/public/card/:uuid/query

Fetch a publicly-accessible Card an return query results as well as :card information. Does not require auth credentials. Public sharing must be enabled.

PARAMS:

  • uuid

  • parameters value may be nil, or if non-nil, value must be a valid JSON string.

## `GET /api/public/card/:uuid/query`

Fetch a publicly-accessible Card an return query results as well as `:card` information. Does not require auth
   credentials. Public sharing must be enabled.

##### PARAMS:

*  **`uuid`** 

*  **`parameters`** value may be nil, or if non-nil, value must be a valid JSON string.
sourceraw docstring

GET_card_:uuid_query_:export-formatclj

GET /api/public/card/:uuid/query/:export-format

Fetch a publicly-accessible Card and return query results in the specified format. Does not require auth credentials. Public sharing must be enabled.

PARAMS:

  • uuid

  • export-format value must be one of: csv, json, xlsx.

  • parameters value may be nil, or if non-nil, value must be a valid JSON string.

  • respond

  • raise

## `GET /api/public/card/:uuid/query/:export-format`

Fetch a publicly-accessible Card and return query results in the specified format. Does not require auth
   credentials. Public sharing must be enabled.

##### PARAMS:

*  **`uuid`** 

*  **`export-format`** value must be one of: `csv`, `json`, `xlsx`.

*  **`parameters`** value may be nil, or if non-nil, value must be a valid JSON string.

*  **`respond`** 

*  **`raise`**
sourceraw docstring

GET_dashboard_:uuidclj

GET /api/public/dashboard/:uuid

Fetch a publicly-accessible Dashboard. Does not require auth credentials. Public sharing must be enabled.

PARAMS:
  • uuid
## `GET /api/public/dashboard/:uuid`

Fetch a publicly-accessible Dashboard. Does not require auth credentials. Public sharing must be enabled.

##### PARAMS:

*  **`uuid`**
sourceraw docstring

GET_dashboard_:uuid_card_:card-idclj

GET /api/public/dashboard/:uuid/card/:card-id

Fetch the results for a Card in a publicly-accessible Dashboard. Does not require auth credentials. Public sharing must be enabled.

PARAMS:

  • uuid

  • card-id

  • parameters value may be nil, or if non-nil, value must be a valid JSON string.

## `GET /api/public/dashboard/:uuid/card/:card-id`

Fetch the results for a Card in a publicly-accessible Dashboard. Does not require auth credentials. Public
   sharing must be enabled.

##### PARAMS:

*  **`uuid`** 

*  **`card-id`** 

*  **`parameters`** value may be nil, or if non-nil, value must be a valid JSON string.
sourceraw docstring

GET_dashboard_:uuid_field_:field-id_remapping_:remapped-idclj

GET /api/public/dashboard/:uuid/field/:field-id/remapping/:remapped-id

Fetch remapped Field values. This is the same as GET /api/field/:id/remapping/:remapped-id, but for use with public Dashboards.

PARAMS:

  • uuid

  • field-id

  • remapped-id

  • value value must be a non-blank string.

## `GET /api/public/dashboard/:uuid/field/:field-id/remapping/:remapped-id`

Fetch remapped Field values. This is the same as `GET /api/field/:id/remapping/:remapped-id`, but for use with public
  Dashboards.

##### PARAMS:

*  **`uuid`** 

*  **`field-id`** 

*  **`remapped-id`** 

*  **`value`** value must be a non-blank string.
sourceraw docstring

GET_dashboard_:uuid_field_:field-id_search_:search-field-idclj

GET /api/public/dashboard/:uuid/field/:field-id/search/:search-field-id

Search for values of a Field that is referenced by a Card in a public Dashboard.

PARAMS:

  • uuid

  • field-id

  • search-field-id

  • value value must be a non-blank string.

  • limit value may be nil, or if non-nil, value must be a valid integer greater than zero.

## `GET /api/public/dashboard/:uuid/field/:field-id/search/:search-field-id`

Search for values of a Field that is referenced by a Card in a public Dashboard.

##### PARAMS:

*  **`uuid`** 

*  **`field-id`** 

*  **`search-field-id`** 

*  **`value`** value must be a non-blank string.

*  **`limit`** value may be nil, or if non-nil, value must be a valid integer greater than zero.
sourceraw docstring

GET_dashboard_:uuid_field_:field-id_valuesclj

GET /api/public/dashboard/:uuid/field/:field-id/values

Fetch FieldValues for a Field that is referenced by a Card in a public Dashboard.

PARAMS:

  • uuid

  • field-id

## `GET /api/public/dashboard/:uuid/field/:field-id/values`

Fetch FieldValues for a Field that is referenced by a Card in a public Dashboard.

##### PARAMS:

*  **`uuid`** 

*  **`field-id`**
sourceraw docstring

GET_oembedclj

GET /api/public/oembed

oEmbed endpoint used to retreive embed code and metadata for a (public) Metabase URL.

PARAMS:

  • url value must be a non-blank string.

  • format value may be nil, or if non-nil, value must be one of: json.

  • maxheight value may be nil, or if non-nil, value must be a valid integer.

  • maxwidth value may be nil, or if non-nil, value must be a valid integer.

## `GET /api/public/oembed`

oEmbed endpoint used to retreive embed code and metadata for a (public) Metabase URL.

##### PARAMS:

*  **`url`** value must be a non-blank string.

*  **`format`** value may be nil, or if non-nil, value must be one of: `json`.

*  **`maxheight`** value may be nil, or if non-nil, value must be a valid integer.

*  **`maxwidth`** value may be nil, or if non-nil, value must be a valid integer.
sourceraw docstring

public-cardclj

(public-card & conditions)

Return a public Card matching key-value CONDITIONS, removing all columns that should not be visible to the general public. Throws a 404 if the Card doesn't exist.

Return a public Card matching key-value CONDITIONS, removing all columns that should not be visible to the general
public. Throws a 404 if the Card doesn't exist.
sourceraw docstring

public-dashboardclj

(public-dashboard & conditions)

Return a public Dashboard matching key-value CONDITIONS, removing all columns that should not be visible to the general public. Throws a 404 if the Dashboard doesn't exist.

Return a public Dashboard matching key-value CONDITIONS, removing all columns that should not be visible to the
general public. Throws a 404 if the Dashboard doesn't exist.
sourceraw docstring

public-dashcard-results-asyncclj

(public-dashcard-results-async dashboard-id
                               card-id
                               parameters
                               &
                               {:keys [context]
                                :or {context :public-dashboard}})

Return the results of running a query with parameters for Card with card-id belonging to Dashboard with dashboard-id. Throws a 404 immediately if the Card isn't part of the Dashboard.

Otherwise returns channel for fetching results.

Return the results of running a query with `parameters` for Card with `card-id` belonging to Dashboard with
`dashboard-id`. Throws a 404 immediately if the Card isn't part of the Dashboard.

Otherwise returns channel for fetching results.
sourceraw docstring

routesclj

Ring routes for api/public: (GET_card_:uuid GET_card_:uuid_field_:field-id_values GET_dashboard_:uuid_field_:field-id_remapping_:remapped-id GET_dashboard_:uuid_field_:field-id_values GET_card_:uuid_field_:field-id_remapping_:remapped-id GET_card_:uuid_query_:export-format GET_card_:uuid_query GET_dashboard_:uuid_field_:field-id_search_:search-field-id GET_dashboard_:uuid GET_dashboard_:uuid_card_:card-id GET_oembed GET_card_:uuid_field_:field-id_search_:search-field-id)

Ring routes for api/public:
(GET_card_:uuid
 GET_card_:uuid_field_:field-id_values
 GET_dashboard_:uuid_field_:field-id_remapping_:remapped-id
 GET_dashboard_:uuid_field_:field-id_values
 GET_card_:uuid_field_:field-id_remapping_:remapped-id
 GET_card_:uuid_query_:export-format
 GET_card_:uuid_query
 GET_dashboard_:uuid_field_:field-id_search_:search-field-id
 GET_dashboard_:uuid
 GET_dashboard_:uuid_card_:card-id
 GET_oembed
 GET_card_:uuid_field_:field-id_search_:search-field-id)
sourceraw docstring

run-query-for-card-with-id-asyncclj

(run-query-for-card-with-id-async card-id parameters & options)

Run the query belonging to Card with card-id with parameters and other query options (e.g. :constraints). Returns core.async channel to fetch the results.

Run the query belonging to Card with `card-id` with `parameters` and other query options (e.g. `:constraints`).
Returns core.async channel to fetch the results.
sourceraw docstring

search-card-fieldsclj

(search-card-fields card-id field-id search-id value limit)

Wrapper for metabase.api.field/search-values for use with public/embedded Cards. See that functions documentation for a more detailed explanation of exactly what this does.

Wrapper for `metabase.api.field/search-values` for use with public/embedded Cards. See that functions
documentation for a more detailed explanation of exactly what this does.
sourceraw docstring

search-dashboard-fieldsclj

(search-dashboard-fields dashboard-id field-id search-id value limit)

Wrapper for metabase.api.field/search-values for use with public/embedded Dashboards. See that functions documentation for a more detailed explanation of exactly what this does.

Wrapper for `metabase.api.field/search-values` for use with public/embedded Dashboards. See that functions
documentation for a more detailed explanation of exactly what this does.
sourceraw docstring

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

Keyboard shortcutsReport a problemcljdoc on GitHub
× close