警告

/api/alert端点。

DELETE /api/alert/:id/subscription

允许用户取消订阅给定的警报。

参数

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

GET /api/alert/

获取当前用户创建或将收到的警报，如果用户是管理员，则获取所有警报。可选的user_id将返回对应用户创建的警报，但对于非管理员用户将被忽略。

参数

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

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

GET /api/alert/:id

通过ID获取警报。

参数

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

GET /api/alert/question/:id

获取给定问题（卡片）ID的所有警报。

参数

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

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

POST /api/alert/

创建一个新的警报。

参数

• alert_condition 枚举值有 rows 和 goal。

• card 值必须是一个包含键 id、include_csv、include_xls 和 dashboard_card_id 的映射。

• channels 一或多个映射。

• alert_first_only 布尔值。

• alert_above_goal 可空布尔值。

• new-alert-request-body

PUT /api/alert/:id

使用 ID 更新一个 Alert。

参数

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

• alert_condition 可空枚举值有 rows 和 goal。

• alert_first_only 可空布尔值。

• alert_above_goal 可空布尔值。

• card 可空值必须是一个包含键 id、include_csv、include_xls 和 dashboard_card_id 的映射。

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

• archived 可空布尔值。

• alert-updates

<< 返回 API 索引