公共

Metabase API端点，用于查看公开访问的卡和仪表板。

GET /api/public/action/:uuid

获取公开可访问的操作。不需要认证凭据。必须启用公共共享。

参数

• uuid值必须是一个有效的UUID。

GET /api/public/card/:uuid

获取公开可访问的卡片，并返回查询结果以及:card信息。不需要认证凭据。必须启用公共共享。

参数

• uuid值必须是一个有效的UUID。

GET /api/public/card/:uuid/field/:field-id/remapping/:remapped-id

获取重新映射的字段值。这与GET /api/field/:id/remapping/:remapped-id相同，但用于公共卡片。

参数

• uuid值必须是一个有效的UUID。

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

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

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

GET /api/public/card/:uuid/field/:field-id/search/:search-field-id

搜索由公开卡片引用的字段值。

参数

• uuid值必须是一个有效的UUID。

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

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

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

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

GET /api/public/card/:uuid/field/:field-id/values

获取由公开卡片引用的字段的FieldValues。

参数

• uuid值必须是一个有效的UUID。

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

GET /api/public/card/:uuid/params/:param-key/search/:query

获取包含query的公共卡片上的参数值。

参数

• uuid值必须是一个有效的UUID。

• param-key值必须是一个非空字符串。

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

GET /api/public/card/:uuid/params/:param-key/values

获取公共卡片上的参数值。

参数

• uuid值必须是一个有效的UUID。

• param-key值必须是一个非空字符串。

GET /api/public/card/:uuid/query

获取公开可访问的卡片，并返回查询结果以及:card信息。不需要认证凭据。必须启用公共共享。

参数

• uuid值必须是一个有效的UUID。

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

GET /api/public/card/:uuid/query/:export-format

获取公开可访问的卡片，并以指定格式返回查询结果。不需要认证凭据。必须启用公共共享。

参数

• uuid值必须是一个有效的UUID。

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

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

• format_rows可空布尔值。

GET /api/public/dashboard/:uuid

获取公开访问的仪表盘。不需要认证凭据。必须启用公开分享。

参数

• uuid值必须是一个有效的UUID。

GET /api/public/dashboard/:uuid/dashcard/:dashcard-id/card/:card-id

获取公开访问仪表盘中卡的查询结果。不需要认证凭据。必须启用公开分享。

参数

• uuid值必须是一个有效的UUID。

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

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

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

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

获取填充执行参数的值。传递PK参数和值以进行选择。

参数

• uuid值必须是一个有效的UUID。

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

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

GET /api/public/dashboard/:uuid/field/:field-id/remapping/:remapped-id

获取重映射字段的值。这与GET /api/field/:id/remapping/:remapped-id相同，但用于公开仪表盘。

参数

• uuid值必须是一个有效的UUID。

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

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

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

GET /api/public/dashboard/:uuid/field/:field-id/search/:search-field-id

搜索公开仪表盘中卡片引用的字段值。

参数

• uuid值必须是一个有效的UUID。

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

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

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

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

GET /api/public/dashboard/:uuid/field/:field-id/values

获取公开仪表盘中卡片引用的字段的FieldValues。

参数

• uuid值必须是一个有效的UUID。

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

GET /api/public/dashboard/:uuid/params/:param-key/search/:query

获取仪表板参数param-key的筛选值，包含指定的query。

参数

• uuid值必须是一个有效的UUID。

• param-key值必须是一个非空字符串。

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

• constraint-param-key->value

GET /api/public/dashboard/:uuid/params/:param-key/values

获取仪表板参数param-key的筛选值。

参数

• uuid值必须是一个有效的UUID。

• param-key值必须是一个非空字符串。

• constraint-param-key->value

GET /api/public/oembed

用于检索（公开）Metabase URL的嵌入代码和元数据的oEmbed端点。

参数

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

• format可为null的枚举值json。

• maxheight可为null的值必须是一个有效的整数。

• maxwidth可为null的值必须是一个有效的整数。

GET /api/public/pivot/card/:uuid/query

获取公开可访问的卡片，并返回查询结果以及:card信息。不需要认证凭据。必须启用公共共享。

参数

• uuid值必须是一个有效的UUID。

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

GET /api/public/pivot/dashboard/:uuid/dashcard/:dashcard-id/card/:card-id

获取公开访问仪表盘中卡的查询结果。不需要认证凭据。必须启用公开分享。

参数

• uuid值必须是一个有效的UUID。

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

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

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

POST /api/public/action/:uuid/execute

执行操作。

parameters应该是带有值的映射仪表板参数。

参数

• uuid值必须是一个有效的UUID。

• parameters可为null的从到.

• _body

POST /api/public/dashboard/:uuid/dashcard/:dashcard-id/card/:card-id/:export-format

获取属于仪表盘的公开访问卡片的结果，并以一种导出格式返回数据。不需要认证凭据。必须启用公开分享。

参数

• uuid值必须是一个有效的UUID。

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

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

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

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

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

在Dashboard和DashboardCard的上下文中执行关联的操作，该上下文中包含它。

parameters应该是带有值的映射仪表板参数。

参数

• uuid值必须是一个有效的UUID。

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

• parameters可为null的从到.

• _body

---

« 返回API索引