Оповещение

Методы API для оповещений.

DELETE /api/alert/:id/subscription

Для того, чтобы пользователи могли отписаться от данного оповещения.

Параметры:

  • id значение должно быть целым числом больше нуля.

GET /api/alert/

Получить все оповещения.

Параметры:

  • archived значение может быть пустым или, если не пустым, должно быть допустимой строкой булева типа (’правда’ или ‘ложь’).

  • user_id значение может быть пустым или, если не пустым, должно быть целым числом больше нуля.

GET /api/alert/:id

Получить оповещение по ID.

Параметры:

  • id значение должно быть целым числом больше нуля.

GET /api/alert/question/:id

Получить все вопросы для данного вопроса (Card) id.

Параметры:

  • id значение может быть пустым или не пустым, должно быть целым числом больше нуля.

  • archived значение может быть пустым или не пустым, должно быть допустимой строкой булевого типа (’правда’ или ‘ложь’).

POST /api/alert/

Создать новое оповещение.

Параметры:

  • alert_condition значение должно быть одним из: goal, rows.

  • card значение должно быть картой с ключами id, include_csv, include_xls, и dashboard_card_id.

  • channels значение должно быть массивом. Каждое значение должно быть картой. Массив не должен быть пустым.

  • alert_first_only значение должно быть булевым типом.

  • alert_above_goal значение может быть пустым или не пустым, значение должно быть булевым типом.

  • new-alert-request-body

PUT /api/alert/:id

Обновление Alert с ID.

Параметры:

  • id

  • alert_condition значение должно быть пустым или не пустым, должно быть одним из: goal, rows.

  • alert_first_only значение может быть пустым или не пустым, значение должно быть булевым типом.

  • alert_above_goal значение может быть пустым или не пустым, значение должно быть булевым типом.

  • card значение может быть пустым или не пустым, значение должно быть картой с ключами id, include_csv, include_xls, и dashboard_card_id.

  • channels значение может быть пустым или не пустым, должно быть массивом. Каждое значение должно быть картой. Массив не может быть пустым.

  • archived значение может быть пустым или не пустым, значение должно быть булевым типом.

  • alert-updates


<< Назад к разделу API