脉冲

/api/pulse端点。

DELETE /api/pulse/:id/subscription

用于用户取消对脉冲订阅的订阅。

参数

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

GET /api/pulse/

检索所有仪表板订阅。默认情况下，仅返回当前用户具有写入权限的订阅。对于管理员，这是所有订阅；对于非管理员，仅是他们创建的订阅。

如果指定了dashboard_id，则将结果限制为该仪表板的订阅。

如果 created_or_receive 为 true，则特别返回所有当前用户创建的或已知为收件人的订阅。请注意，这超出了非管理员默认返回的项目集合，并且是管理员默认返回的项目集合的一个子集。这用于支撑 /account/notifications 页面。这可能会包括当前用户没有收集权限的订阅，在这种情况下，某些敏感元数据（卡片和收件人列表）会被删除。

参数

• archived 可空值必须是一个有效的布尔字符串（‘true’ 或 ‘false’）。

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

• creator_or_recipient 可空值必须是一个有效的布尔字符串（‘true’ 或 ‘false’）。

GET /api/pulse/:id

获取具有 ID 的 Pulse。如果用户是 Pulse 的收件人但没有对其收集的读取权限，我们仍然返回它，但会删除一些敏感元数据。

参数

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

GET /api/pulse/form_input

提供创建/更新 Pulses 的相关配置信息和用户选择。

GET /api/pulse/preview_card/:id

获取具有 id 的 Card 的 HTML 渲染。

参数

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

GET /api/pulse/preview_card_info/:id

获取包含具有 id 的 Card 的 HTML 渲染和其他信息的 JSON 对象。

参数

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

GET /api/pulse/preview_card_png/:id

获取具有 id 的 Card 的 PNG 渲染。

参数

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

GET /api/pulse/preview_dashboard/:id

获取具有 id 的 Dashboard 的 HTML 渲染。

此端点依赖于在 metabase.pulse.preview/style-tag-nonce-middleware 中定义的自定义中间件，以允许样式标签在 Content Security Policy 设置下正确渲染。此中间件使用 metabase.api.common/define-routes 在此命名空间底部附加到这些路由。

参数

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

POST /api/pulse/

创建一个新的 Pulse。

参数

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

• cards 一个或多个值必须是一个具有以下键的映射 (collection_id, description, display, id, include_csv, include_xls, name, dashboard_id, parameter_mappings)，或者值必须是一个具有以下键的映射 id，include_csv，include_xls 和 dashboard_card_id，或者值必须是一个具有以下键的映射 include_csv，include_xls 和 dashboard_card_id。

• channels 一个或多个映射。

• skip_if_empty 可空布尔值。

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

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

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

• parameters 可空映射序列。

POST /api/pulse/test

测试发送未保存的脉冲。

参数

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

• cards 一个或多个值必须是一个具有以下键的映射 (collection_id, description, display, id, include_csv, include_xls, name, dashboard_id, parameter_mappings)，或者值必须是一个具有以下键的映射 id，include_csv，include_xls 和 dashboard_card_id，或者值必须是一个具有以下键的映射 include_csv，include_xls 和 dashboard_card_id。

• channels 一个或多个映射。

• skip_if_empty 可空布尔值。

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

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

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

PUT /api/pulse/:id

更新具有 id 的 Pulse。

参数

• skip_if_empty 可空布尔值。

• parameters 可空序列值必须是一个映射。

• archived 可空布尔值。

• channels 可空一个或多个映射。

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

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

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

• cards 可以为空或一个或多个值，必须是一个具有以下键的映射 (collection_id, description, display, id, include_csv, include_xls, name, dashboard_id, parameter_mappings)，或者值必须是一个具有以下键的映射 id、include_csv、include_xls 和 dashboard_card_id，或者值必须是一个具有以下键的映射 include_csv、include_xls 和 dashboard_card_id。

• 脉冲更新

---

返回 API 索引