Breaking changes to the API interface
Metabase 0.50.0
-
GET /api/dashboard/:id/query_metadata
New endpoint that combines responses for
/api/field/:id
,/api/database/:id
, and/api/table/:id/query_metadata
. This should drastically cut down on the required number of requests to display a dashboard. -
GET /api/card/:id/query_metadata
New endpoint that combines responses for
/api/field/:id
,/api/database/:id
, and/api/table/:id/query_metadata
. This should drastically cut down on the required number of requests to display a card. -
GET /api/collection/tree
andGET /api/collection/:id/items
These API endpoints will always return official collections first, before other items in the collection. -
/api/metric
The
/api/metric
endpoints has been renamed to/api/legacy-metric
to reflect that fact it will not be used for the new version of metrics. The new version uses the/api/card
endpoints. -
GET /api/permissions/graph
andPUT /api/permissions/graph
The
data
key has been removed from the permissions graph. Thedata
key has been replaced with two new keys:view-data
andcreate-queries
. Valid permission values forview-data
areunrestricted
,blocked
,sandboxed
orrestricted
. Valid permission values forcreate-queries
arequery-builder-and-native
,query-builder
, andno
.If you’re scripting permissions, you’ll need to update your scripts to reflect these breaking changes to the
/api/permissions/graph
endpoints. For more about the new data permissions of View data and Create queries, see our docs on data permissions. And here’s a page that talks about the change (and why we did it). -
GET /api/transform/:db-id/:schema/:transform-name
, which hasn’t been used internally by Metabase for ages, has been removed.
Metabase 0.49.5
NOTE: These endpoint changes were added in 0.49.3, and a bug in GET /api/embed/card/:token/query/:export-format
was fixed in 0.49.5.
POST /api/card/:card-id/query/:export-format
POST /api/:dashboard-id/dashcard/:dashcard-id/card/:card-id/query/:export-format
POST /api/dataset/:export-format
GET /api/embed/card/:token/query/:export-format
-
GET /api/embed/dashboard/:token/dashcard/:dashcard-id/card/:card-id/:export-format
The above endpoints now accept the
format_rows
query parameter. It is an optional boolean parameter that will default totrue
if not included in the request. Whenformat_rows
istrue
, the export will have formatting applied such that the values match what they appear as in the app. Whenformat_rows
isfalse
, formatting is not applied and exports will behave as they did prior to 0.49.0.The value of
format_rows
has no effect when exporting xlsx files.
Metabase 0.49.0
-
POST /api/card
andPUT /api/card/:id
The
dataset
key is deprecated and will be removed in a future version, most likely 50. In its place we have added a new key:type
which is equivalent in that it distinguishes Models from Questions.type="model"
is equivalent todataset=true
andtype="question"
is equivalent todataset=false
. -
all endpoints that return data (e.g. exports in JSON, XLSX, CSV, endpoints that end in “/query”)
Starting from v49, we respond to the API calls with values formatted according to the instance localization options
API documentation
See API documentation.
Read docs for other versions of Metabase.