API 接口的重大更改

Metabase 0.52.0

  • POST /api/user/:id/send_invite 已被移除。
  • GET /:id/fields 现在包含表 ID。

  • /api/pulse/api/alert 下的 API 将在未来版本中移除,因为我们正在过渡到新的架构。

Metabase 0.51.0

  • GET /api/dashboard/:id/query_metadata

    合并了 /api/field/:id/api/database/:id/api/table/:id/query_metadata 响应的新端点。这应大幅减少显示卡片所需的请求数量。

  • GET /api/card/:id/query_metadata

    合并了 /api/field/:id/api/database/:id/api/table/:id/query_metadata 响应的新端点。这应大幅减少显示仪表板所需的请求数量。

  • /api/legacy-metric

    /api/legacy-metric 端点已被移除。

  • POST /api/session/pulse/unsubscribePOST /api/session/pulse/unsubscribe/undo 已分别移至 POST /api/pulse/unsubscribePOST /api/pulse/unsubscribe/undo

Metabase 0.50.0

  • GET /api/collection/treeGET /api/collection/:id/items 这些 API 端点将始终首先返回官方集合,然后再返回集合中的其他项目。

  • PUT /api/dashboard/:idPUT /api/card/:idPUT /api/collection/:id

    当将 archived 设置为 true 时,仪表板、卡片或集合将自动移至回收站集合,这是一个特殊的集合,其中包含所有已存档的项目。

    当将 archived 设置为 false 时,您可以选择性地提供 collection_id(对于仪表板或卡片)或 parent_id(对于集合)。在这种情况下,当实体从回收站移出时,将重新归属于指定的集合。如果未提供新的 collection_idparent_id,则实体将尽可能移回其原始位置。如果不可能(例如,原始位置也在回收站中),则会发生错误。

  • /api/metric

    /api/metric 端点已重命名为 /api/legacy-metric,以反映它不会用于新版本指标的事实。新版本使用 /api/card 端点。

  • GET /api/permissions/graphPUT /api/permissions/graph

    权限图中已移除 data 键。data 键已替换为两个新键:view-datacreate-queriesview-data 的有效权限值为 unrestrictedblockedsandboxedrestrictedcreate-queries 的有效权限值为 query-builder-and-nativequery-builderno

    如果您正在编写权限脚本,则需要更新脚本以反映 /api/permissions/graph 端点的这些重大更改。有关查看数据和创建查询的新数据权限的更多信息,请参阅我们的 数据权限文档。这是 讨论更改(以及我们为何进行更改)的页面。

  • 已移除 GET /api/transform/:db-id/:schema/:transform-name,Metabase 内部已久未使用此端点。

  • POST /api/user/:id/send_invite 已弃用,将在下一个版本中移除。

Metabase 0.49.5

注意:这些端点更改是在 0.49.3 中添加的,GET /api/embed/card/:token/query/:export-format 中的错误已在 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

    以上端点现在接受 format_rows 查询参数。这是一个可选的布尔参数,如果请求中未包含,则默认为 true。当 format_rowstrue 时,导出将应用格式设置,使值与它们在应用中显示的方式相匹配。当 format_rowsfalse 时,不应用格式设置,导出行为将与 0.49.0 之前的行为相同。

    导出 xlsx 文件时,format_rows 的值无效。

Metabase 0.49.0

  • POST /api/cardPUT /api/card/:id

    dataset 键已弃用,将在未来版本(很可能是 50)中移除。我们添加了一个新键来替代它:type,它在区分模型和问题方面是等效的。type="model" 等同于 dataset=truetype="question" 等同于 dataset=false

  • 返回数据的所有端点(例如,JSON、XLSX、CSV 格式的导出,以及以“/query”结尾的端点)

    从 v49 开始,我们使用根据实例本地化选项格式化的值响应 API 调用

阅读其他 Metabase 版本的文档。