定价
登录 开始使用
文档 学习
首页
数据分析
嵌入
管理
其他资源

仪表盘

/api/dashboard端点。

删除此仪表板的公开访问链接。

参数

  • dashboard-id值必须是一个大于零的整数。

DELETE /api/dashboard/:id

硬删除仪表板。要软删除，请使用 PUT /api/dashboard/:id

这将删除使用此数据库的所有问题/模型/段/指标。

参数

  • id 的值必须是一个大于零的整数。

GET /api/dashboard/

此端点目前未被 Metabase 前端使用，可能与应用程序的其他部分过时。它仅存在于向后兼容性，可能在未来被删除。

获取 仪表板。使用过滤器选项 f（默认 all），如下限制结果

  • all - 返回所有仪表板。
  • mine - 返回由当前用户创建的仪表板。
  • archived - 返回已存档的仪表板。（默认情况下，这些是 排除 的。）

参数

  • f 可为 null 的枚举值，包括 all、mine、archived。

GET /api/dashboard/:dashboard-id/dashcard/:dashcard-id/execute

检索用于填充执行参数的值。传递 PK 参数和值以进行选择。

参数

  • dashboard-id值必须是一个大于零的整数。

  • dashcard-id 的值必须是一个大于零的整数。

  • parameters 的值必须是一个有效的 JSON 字符串。

GET /api/dashboard/:id

获取具有 ID 的仪表板。

参数

  • id 的值必须是一个大于零的整数。

  • dashboard-load-id

GET /api/dashboard/:id/params/:param-key/search/:query

获取 ID 为 :param-key 的参数的可能值，这些值包含 :query。可选地通过传递查询参数如 other-parameter=value 限制这些值，例如。

;; fetch values for Dashboard 1 parameter 'abc' that contain 'Cam' and are possible when parameter 'def' is set
;; to 100
 GET /api/dashboard/1/params/abc/search/Cam?def=100

目前限制为前 1000 个结果。

参数

  • id 的值必须是一个大于零的整数。

  • param-key

  • query 的值必须是非空字符串。

  • constraint-param-key->value

GET /api/dashboard/:id/params/:param-key/values

获取 ID 为 :param-key 的参数的可能值。如果值直接来自查询，可选地通过传递查询参数如 other-parameter=value 限制这些值，例如。

;; fetch values for Dashboard 1 parameter 'abc' that are possible when parameter 'def' is set to 100
GET /api/dashboard/1/params/abc/values?def=100.

参数

  • id 的值必须是一个大于零的整数。

  • param-key

  • constraint-param-key->value

GET /api/dashboard/:id/query_metadata

获取仪表板上卡片所需的所有查询元数据。

参数

  • id 的值必须是一个大于零的整数。

  • dashboard-load-id

GET /api/dashboard/:id/related

返回相关实体。

参数

  • id 的值必须是一个大于零的整数。

GET /api/dashboard/:id/revisions

获取具有 ID 的仪表板的 Revisions。

参数

  • id 的值必须是一个大于零的整数。

GET /api/dashboard/embeddable

获取 enable_embedding 为 true 的仪表板列表。这些仪表板可以使用嵌入端点和签名 JWT 进行嵌入。

GET /api/dashboard/params/valid-filter-fields

为仪表板 UI 提供功能的实用端点。给定一些 filtered 字段 ID 集合（可能是用于参数的字段）和一组将用于限制 filtered 字段值的 filtering 字段 ID，对于每个 filtered 字段 ID 返回实际会在链式过滤器查询中使用这些字段的 filtering 字段 ID 子集。

例如，在链式过滤器查询中

GET /api/dashboard/10/params/PARAM_1/values?PARAM_2=100

假设 PARAM_1 映射到字段1，PARAM_2 映射到字段2和3。底层的MBQL查询可能或可能不针对字段2和3进行过滤，这取决于是否可以找到允许我们对字段1进行连接的外键关系。您可以使用此端点来确定实际使用哪些字段。

GET /api/dashboard/params/valid-filter-fields?filtered=1&filtering=2&filtering=3 ;; -> {1 [2 3]}

结果以映射的形式返回

filtered 字段ID -> 链式过滤查询中将要使用的 filtering 字段ID的子集。

参数

  • filtered 向量中的值必须是大于零的整数。

  • filtering 可空向量中的值必须是大于零的整数。

GET /api/dashboard/public

获取具有公共UUID的仪表板列表。如果启用了公共共享，则这些仪表板是公开可访问的。

POST /api/dashboard/

创建一个新的仪表板。

参数

  • name 的值必须是非空字符串。

  • description 可空字符串。

  • parameters 可空序列，参数必须是具有 :id 和 :type 键的映射。

  • cache_ttl 可空值必须是一个大于零的整数。

  • collection_id 可空值必须是一个大于零的整数。

  • collection_position 可空值必须是一个大于零的整数。

  • _dashboard

POST /api/dashboard/:dashboard-id/dashcard/:dashcard-id/card/:card-id/query

在包含该仪表板的 Dashboard 的上下文中运行与保存问题（Card）关联的查询。

参数

  • dashboard-id值必须是一个大于零的整数。

  • dashcard-id 的值必须是一个大于零的整数。

  • card-id 的值必须是一个大于零的整数。

  • dashboard_load_id 可空值必须是一个非空字符串。

  • parameters 可空序列，值必须是一个具有 id 键的参数映射。

POST /api/dashboard/:dashboard-id/dashcard/:dashcard-id/card/:card-id/query/:export-format

在包含该仪表板的 Dashboard 的上下文中运行与保存问题（Card）关联的查询，并以指定格式返回其结果作为文件。

parameters 应作为查询参数传递，编码为序列化的JSON字符串（这是因为此端点通常用于为使用HTML form 动作的“下载结果”按钮提供动力）。

参数

  • dashboard-id值必须是一个大于零的整数。

  • dashcard-id 的值必须是一个大于零的整数。

  • card-id 的值必须是一个大于零的整数。

  • export-format 枚举为 csv, api, xlsx, json。

  • parameters 可空值必须是一个有效的JSON字符串。

  • format_rows 可空布尔值。

  • request-parameters

POST /api/dashboard/:dashboard-id/dashcard/:dashcard-id/execute

在包含该仪表板和 DashboardCard 的上下文中执行关联的操作。

parameters 应当是具有值的映射仪表板参数。 extra_parameters 应当是额外用户输入的参数值。

参数

  • dashboard-id值必须是一个大于零的整数。

  • dashcard-id 的值必须是一个大于零的整数。

  • parameters 可为空的从到.

  • _body

POST /api/dashboard/:dashboard-id/public_link

为该仪表板生成公开访问链接。返回用于公开链接的 UUID。 (如果此仪表板已共享，则返回现有公开链接而不是创建新的链接。) 公开共享必须启用。

您必须具有超级用户权限才能执行此操作。

参数

  • dashboard-id值必须是一个大于零的整数。

POST /api/dashboard/:from-dashboard-id/copy

复制仪表板。

参数

  • from-dashboard-id 可为空的值必须是一个大于零的整数。

  • name 可为空的值必须是一个非空字符串。

  • description 可空字符串。

  • collection_id 可空值必须是一个大于零的整数。

  • collection_position 可空值必须是一个大于零的整数。

  • is_deep_copy 可为空的布尔值。

  • _dashboard

POST /api/dashboard/:id/revert

将仪表板还原到以前的 修订版。

参数

  • id 的值必须是一个大于零的整数。

  • revision_id 值必须是一个大于零的整数。

POST /api/dashboard/pivot/:dashboard-id/dashcard/:dashcard-id/card/:card-id/query

为特定的 DashCard 运行交叉表查询。

参数

  • dashboard-id值必须是一个大于零的整数。

  • dashcard-id 的值必须是一个大于零的整数。

  • card-id 的值必须是一个大于零的整数。

  • parameters 可空序列，值必须是一个具有 id 键的参数映射。

POST /api/dashboard/save

保存仪表板的非规范化描述。

参数

  • dashboard

POST /api/dashboard/save/collection/:parent-collection-id

将仪表板的非规范化描述保存到 ID 为 :parent-collection-id 的集合中。

参数

  • parent-collection-id 值必须是一个大于零的整数。

  • dashboard

PUT /api/dashboard/:id

更新仪表板，以及可选的仪表板的 dashcards 和 tabs。请求体应是一个与 GET /api/dashboard/:id 响应相同的结构的 JSON 对象。

参数

  • id 的值必须是一个大于零的整数。

  • dash-updates map 其中 {:name (可选) ->, :description (可选) ->, :caveats (可选) ->, :points_of_interest (可选) ->, :show_in_getting_started (可选) ->, :enable_embedding (可选) ->, :embedding_params (可选) ->, :parameters (可选) -> <可为空的参数序列必须是一个具有 :id 和 :type 键的映射>, :position (可选) ->, :width (可选) -> <枚举为 fixed, full>, :archived (可选) ->, :collection_id (可选) ->, :collection_position (可选) ->, :cache_ttl (可选) ->, :dashcards (可选) ->, :tabs (可选) ->}.

PUT /api/dashboard/:id/cards

(已弃用 – 使用 PUT /api/dashboard/:id 端点代替。) 更新仪表板上的 Cards 和 Tabs。请求体应具有以下形式

{:cards        [{:id                 ... ; DashboardCard ID
                 :size_x             ...
                 :size_y             ...
                 :row                ...
                 :col                ...
                 :parameter_mappings ...
                 :series             [{:id 123
                                       ...}]}
                 ...]
 :tabs [{:id       ... ; DashboardTab ID
                 :name     ...}]}.

参数

  • id 的值必须是一个大于零的整数。

  • cards 值必须是具有唯一 id 的映射的序列。

  • tabs 可为空的值必须是具有唯一 id 的映射的序列。

「 回到 API 索引

阅读其他 Metabase 版本的文档。

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