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-queries。有效的 view-data 权限值有 unrestrictedblockedsandboxedrestricted。有效的 create-queries 权限值有 query-builder-and-nativequery-builderno

    如果您正在编写权限脚本,您需要更新您的脚本以反映对 /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_rowstrue 时,导出将应用格式,使值与在应用程序中显示的值匹配。当 format_rowsfalse 时,不应用格式,导出将像 0.49.0 之前那样表现。

    format_rows 的值在导出 xlsx 文件时没有影响。

Metabase 0.49.0

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

    dataset 键已弃用,将在未来的版本中删除,最有可能是在 50。我们添加了一个新的键:type,它在意义上是等效的,它区分了模型和问题。type="model" 等同于 dataset=true,而 type="question" 等同于 dataset=false

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

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

阅读有关 Metabase 其他 版本 的文档。

想改进这些文档? 提出更改。