Skip to content
This repository has been archived by the owner on Jun 5, 2023. It is now read-only.

Latest commit

 

History

History
296 lines (158 loc) · 6.61 KB

public.md

File metadata and controls

296 lines (158 loc) · 6.61 KB
Raw
title summary
Public
Metabase API endpoints for viewing publicly-accessible Cards and Dashboards.

Public

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

GET /api/public/action/:uuid

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

PARAMS:

  • uuid value must be a valid 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

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/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/values

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

PARAMS:

  • uuid

  • field-id

GET /api/public/card/:uuid/params/:param-key/search/:query

Fetch values for a parameter on a public card containing query.

PARAMS:

  • uuid

  • param-key

  • query

GET /api/public/card/:uuid/params/:param-key/values

Fetch values for a parameter on a public card.

PARAMS:

  • uuid

  • param-key

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/: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: api, csv, json, xlsx.

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

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/dashcard/:dashcard-id/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

  • dashcard-id

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

GET /api/public/dashboard/:uuid/dashcard/:dashcard-id/execute

Fetches the values for filling in execution parameters. Pass PK parameters and values to select.

PARAMS:

  • uuid

  • dashcard-id value must be an integer greater than zero.

  • parameters value must be a valid JSON 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.

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/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/params/:param-key/search/:query

Fetch filter values for dashboard parameter param-key, containing specified query.

PARAMS:

  • uuid

  • param-key

  • query

  • query-params

GET /api/public/dashboard/:uuid/params/:param-key/values

Fetch filter values for dashboard parameter param-key.

PARAMS:

  • uuid

  • param-key

  • query-params

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/pivot/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/pivot/dashboard/:uuid/dashcard/:dashcard-id/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

  • dashcard-id

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

POST /api/public/action/:uuid/execute

Execute the Action.

parameters should be the mapped dashboard parameters with values.

PARAMS:

  • uuid value must be a valid UUID.

  • parameters nullable map from to

  • _body

POST /api/public/dashboard/:uuid/dashcard/:dashcard-id/execute

Execute the associated Action in the context of a Dashboard and DashboardCard that includes it.

parameters should be the mapped dashboard parameters with values.

PARAMS:

  • uuid

  • dashcard-id value must be an integer greater than zero.

  • parameters value may be nil, or if non-nil, value must be a map with schema: ( value must be a map with schema: ( p? : pred-name : ) : value must be a map with schema: ( _ : ) )

  • _body

<< Back to API index