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/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 中新增，並且 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 呼叫