Оповещение¶
Методы API для оповещений.
DELETE /api/alert/:id/subscription
¶
Чтобы пользователи могли отписаться от данного оповещения.
Параметры:¶
id
целое число больше нуля.
GET /api/alert/
¶
Получить все оповещения.
Параметры:¶
-
archived
допустимая логическая строка (true
илиfalse
) или null. -
user_id
целое число больше нуля или null.
GET /api/alert/:id
¶
Получить оповещение по ID.
Параметры:¶
id
целое число больше нуля.
GET /api/alert/question/:id
¶
Получить все оповещения для данного запроса (Card) по ID.
Параметры:¶
-
id
целое число больше нуля или null. -
archived
допустимая логическая строка (true
илиfalse
) или null.
POST /api/alert/
¶
Создать новое оповещение.
Параметры:¶
-
alert_condition
значение должно быть одним из:goal
,rows
. -
card
значение должно быть картой с ключамиid
,include_csv
,include_xls
, иdashboard_card_id
. -
channels
одна или более карт. -
alert_first_only
логическое значение. -
alert_above_goal
логическое значение или null. -
new-alert-request-body
PUT /api/alert/:id
¶
Обновить оповещения по ID.
Параметры:¶
-
id
-
alert_condition
null или одно из:goal
,rows
. -
alert_first_only
логическое значение или null. -
alert_above_goal
логическое значение или null. -
card
null или карта с ключамиid
,include_csv
,include_xls
,dashboard_card_id
. -
channels
null или одна или более карт. -
archived
логическое значение или null. -
alert-updates