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 现在包含 Table 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 端点的重大更改。有关查看数据和创建查询的新数据权限的更多信息，请参阅我们关于数据权限的文档。这里还有一页介绍了此更改（以及我们为何这样做）。

• Metabase 内部长期未使用的 GET /api/transform/:db-id/:schema/:transform-name 已移除。

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

Metabase 0.49.5

注意：这些端点更改是在 0.49.3 中添加的，并且在 0.49.5 中修复了 GET /api/embed/card/:token/query/:export-format 中的一个错误。

• 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 来代替它，该键同样用于区分模型（Models）和问题（Questions）。type="model" 等同于 dataset=true，而 type="question" 等同于 dataset=false。

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

  从 v49 开始，我们对 API 调用的响应将根据实例本地化选项进行格式化。