API 接口的重大变更

Metabase 0.55.0

• POST /api/card/from-csv 已重命名为 POST /api/upload/csv。

• GET /api/util/stats 已重命名为 GET /api/analytics/anonymous-stats。

• GET /api/util/bug_report_details 已重命名为 GET /api/bug-reporting/details。

• POST /api/util/product-feedback 已重命名为 POST /api/product-feedback。

• POST /api/util/entity_id 已重命名为 POST /api/eid-translation/translate。

• POST /api/util/password_check 已重命名为 POST /api/session/password-check。

• GET /api/util/logs 已重命名为 GET /api/logger/logs。

• GET /api/util/openapi 已删除；您可以使用 GET /api/docs/openapi.json 代替，其功能相同。

• GET /api/util/diagnostic_info/connection_pool_info 已重命名为 GET /api/bug-reporting/connection-pool-details。

Metabase 0.54.0

• 警报系统已从旧版脉冲基础设施迁移到新的通知系统。此迁移包括以下更改

  • 大多数 /api/alert 端点已被删除，转而使用新的 /api/notification 端点。为了向后兼容，这些端点将保留到下一个版本

    • GET /api/alert
    • GET /api/alert/:id
    • DELETE /api/alert/:id/subscription

  • 开发人员应迁移到使用 /api/notification 端点。参考资料：

    • 新通知系统的概述可在 src/metabase/notification/README.md 中找到
    • 通知 API 文档位于 /api/docs/#tag/apinotification
    • 交互式 API 文档可在 /api/docs 端点获取

Metabase 0.53.0

• POST /api/card/:card-id/query/:export-format

  以前，请求参数（parameters、pivot-results? 和 format-rows?）可以通过查询参数或 application/x-www-form-urlencoded 表单内容发送。在 Metabase 0.53.0 中，参数必须以以下两种方式之一发送：

  • application/x-www-form-urlencoded 表单内容
  • 请求正文中 JSON 编码

  不再支持将参数作为 URL 中的查询参数发送。

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/unsubscribe 和 POST /api/session/pulse/unsubscribe/undo 已分别移至 POST /api/pulse/unsubscribe 和 POST /api/pulse/unsubscribe/undo。

Metabase 0.50.0

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

• PUT /api/dashboard/:id、PUT /api/card/:id 和 PUT /api/collection/:id

  当将 archived 设置为 true 时，仪表盘、卡片或集合将自动移动到垃圾桶集合，这是一个包含所有已存档项目的特殊集合。

  当将 archived 设置为 false 时，您还可以选择提供一个 collection_id（适用于仪表盘或卡片）或一个 parent_id（适用于集合）。在这种情况下，实体将从垃圾桶中移出时重新关联到指定的集合。如果未提供新的 collection_id 或 parent_id，实体将尽可能移回其原始位置。如果无法实现（例如，原始位置也在垃圾桶中），将发生错误。

• /api/metric

  /api/metric 端点已重命名为 /api/legacy-metric，以反映其将不再用于新版指标。新版使用 /api/card 端点。

• GET /api/permissions/graph 和 PUT /api/permissions/graph

  data 键已从权限图中移除。data 键已被两个新键取代：view-data 和 create-queries。view-data 的有效权限值为 unrestricted、blocked、sandboxed 或 restricted。create-queries 的有效权限值为 query-builder-and-native、query-builder 和 no。

  如果您正在编写权限脚本，您需要更新脚本以反映 /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_rows 为 true 时，导出的值将进行格式化，使其与应用程序中显示的值相匹配。当 format_rows 为 false 时，不应用格式化，导出将像 0.49.0 之前一样。

  当导出 xlsx 文件时，format_rows 的值不起作用。

Metabase 0.49.0

• POST /api/card 和 PUT /api/card/:id

  dataset 键已弃用，并将在未来版本（很可能是 50）中移除。取而代之的是，我们添加了一个新键：type，其作用相同，即区分模型和问题。type="model" 等同于 dataset=true，type="question" 等同于 dataset=false。

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

  从 v49 开始，我们根据实例本地化选项格式化 API 调用返回的值