自动化仪表盘

自动仪表板API端点。

GET /api/automagic-dashboards/:entity/:entity-id-or-query

返回实体entity的自动仪表板,其ID为id

参数

  • entity无效实体类型。

  • entity-id-or-query

  • show可空值必须等于all或自然整数。

GET /api/automagic-dashboards/:entity/:entity-id-or-query/cell/:cell-query

返回分析实体entity中的单元格的自动仪表板,其ID由查询cell-query定义。

参数

  • entity无效实体类型。

  • entity-id-or-query的值必须是非空字符串。

  • cell-query的值不能解析为base64编码的JSON。

  • show无效的show值。

GET /api/automagic-dashboards/:entity/:entity-id-or-query/cell/:cell-query/compare/:comparison-entity/:comparison-entity-id-or-query

返回实体entity的自动仪表板中单元格的比较仪表板,其ID为id,由查询cell-query定义;与实体comparison-entity进行比较,其实体ID为comparison-entity-id-or-query

参数

  • entity无效实体类型。

  • entity-id-or-query的值必须是非空字符串。

  • cell-query的值不能解析为base64编码的JSON。

  • show无效的show值。

  • comparison-entity无效的比较实体类型。只能为“table”、“segment”或“adhoc”之一。

  • comparison-entity-id-or-query

GET /api/automagic-dashboards/:entity/:entity-id-or-query/cell/:cell-query/rule/:prefix/:dashboard-template

返回使用仪表板模板dashboard-template分析单元格的自动仪表板,其ID为id,由查询cell-query定义。

参数

  • entity无效实体类型。

  • entity-id-or-query的值必须是非空字符串。

  • cell-query的值不能解析为base64编码的JSON。

  • prefix 前缀值无效。

  • dashboard-template 仪表板模板名称值无效。

  • show无效的show值。

GET /api/automagic-dashboards/:entity/:entity-id-or-query/cell/:cell-query/rule/:prefix/:dashboard-template/compare/:comparison-entity/:comparison-entity-id-or-query

返回实体 entity 的 ID 为 id,通过查询 cell-query 定义的自动仪表板中的单元格的比较仪表板,使用仪表板模板 dashboard-template;与具有 ID comparison-entity-id-or-query 的实体 comparison-entity 进行比较。

参数

  • entity无效实体类型。

  • entity-id-or-query的值必须是非空字符串。

  • cell-query的值不能解析为base64编码的JSON。

  • prefix 前缀值无效。

  • dashboard-template 仪表板模板名称值无效。

  • show无效的show值。

  • comparison-entity无效的比较实体类型。只能为“table”、“segment”或“adhoc”之一。

  • comparison-entity-id-or-query

GET /api/automagic-dashboards/:entity/:entity-id-or-query/compare/:comparison-entity/:comparison-entity-id-or-query

返回具有 ID id 的实体 entity 与具有 ID comparison-entity-id-or-query 的实体 comparison-entity 的比较仪表板。

参数

  • entity无效实体类型。

  • entity-id-or-query的值必须是非空字符串。

  • show无效的show值。

  • comparison-entity无效的比较实体类型。只能为“table”、“segment”或“adhoc”之一。

  • comparison-entity-id-or-query

GET /api/automagic-dashboards/:entity/:entity-id-or-query/query_metadata

返回实体 entity 的 ID 为 id 的自动仪表板的所有元数据。

参数

  • entity无效实体类型。

  • entity-id-or-query

GET /api/automagic-dashboards/:entity/:entity-id-or-query/rule/:prefix/:dashboard-template

返回实体 entity 的 ID 为 id 使用仪表板模板 dashboard-template 的自动仪表板。

参数

  • entity无效实体类型。

  • entity-id-or-query的值必须是非空字符串。

  • prefix 前缀值无效。

  • dashboard-template 仪表板模板名称值无效。

  • show无效的show值。

GET /api/automagic-dashboards/:entity/:entity-id-or-query/rule/:prefix/:dashboard-template/compare/:comparison-entity/:comparison-entity-id-or-query

返回实体 entity 的 ID 为 id 使用仪表板模板 dashboard-template 的比较仪表板;与具有 ID comparison-entity-id-or-query 的实体 comparison-entity 进行比较。

参数

  • entity无效实体类型。

  • entity-id-or-query的值必须是非空字符串。

  • prefix 前缀值无效。

  • dashboard-template 仪表板模板名称值无效。

  • show无效的show值。

  • comparison-entity无效的比较实体类型。只能为“table”、“segment”或“adhoc”之一。

  • comparison-entity-id-or-query

GET /api/automagic-dashboards/database/:id/candidates

返回按有趣度排序的自动仪表板候选列表。

参数

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

GET /api/automagic-dashboards/model_index/:model-index-id/primary_key/:pk-id

返回由 entity 指定的实体详细信息的自动仪表板,其中 id 是索引值 indexed-value 的主键。

参数

  • model-index-id 整数。

  • pk-id 整数。


返回到 API 索引

阅读其他 Metabase 版本 的文档。

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