metabase.api.alert
/api/alert endpoints
/api/alert endpoints
DELETE_:idclj
DELETE /api/alert/:id
Delete an Alert. (DEPRECATED -- don't delete a Alert anymore -- archive it instead.)
PARAMS:
id
## `DELETE /api/alert/:id` Delete an Alert. (DEPRECATED -- don't delete a Alert anymore -- archive it instead.) ##### PARAMS: * **`id`**
GET_clj
GET /api/alert/
Fetch all alerts
PARAMS:
archivedvalue may be nil, or if non-nil, value must be a valid boolean string ('true' or 'false').
## `GET /api/alert/`
Fetch all alerts
##### PARAMS:
* **`archived`** value may be nil, or if non-nil, value must be a valid boolean string ('true' or 'false').GET_question_:idclj
## `GET /api/alert/question/:id` Fetch all questions for the given question (`Card`) id ##### PARAMS: * **`id`**
POST_clj
POST /api/alert/
Create a new Alert.
PARAMS:
-
alert_conditionvalue must be one of:goal,rows. -
cardvalue must be a map with the keysid,include_csv, andinclude_xls. -
channelsvalue must be an array. Each value must be a map. The array cannot be empty. -
alert_first_onlyvalue must be a boolean. -
alert_above_goalvalue may be nil, or if non-nil, value must be a boolean. -
new-alert-request-body
## `POST /api/alert/` Create a new Alert. ##### PARAMS: * **`alert_condition`** value must be one of: `goal`, `rows`. * **`card`** value must be a map with the keys `id`, `include_csv`, and `include_xls`. * **`channels`** value must be an array. Each value must be a map. The array cannot be empty. * **`alert_first_only`** value must be a boolean. * **`alert_above_goal`** value may be nil, or if non-nil, value must be a boolean. * **`new-alert-request-body`**
PUT_:idclj
PUT /api/alert/:id
Update a Alert with ID.
PARAMS:
-
id -
alert_conditionvalue may be nil, or if non-nil, value must be one of:goal,rows. -
cardvalue may be nil, or if non-nil, value must be a map with the keysid,include_csv, andinclude_xls. -
channelsvalue may be nil, or if non-nil, value must be an array. Each value must be a map. The array cannot be empty. -
alert_first_onlyvalue may be nil, or if non-nil, value must be a boolean. -
alert_above_goalvalue may be nil, or if non-nil, value must be a boolean. -
archivedvalue may be nil, or if non-nil, value must be a boolean. -
alert-updates
## `PUT /api/alert/:id` Update a `Alert` with ID. ##### PARAMS: * **`id`** * **`alert_condition`** value may be nil, or if non-nil, value must be one of: `goal`, `rows`. * **`card`** value may be nil, or if non-nil, value must be a map with the keys `id`, `include_csv`, and `include_xls`. * **`channels`** value may be nil, or if non-nil, value must be an array. Each value must be a map. The array cannot be empty. * **`alert_first_only`** value may be nil, or if non-nil, value must be a boolean. * **`alert_above_goal`** value may be nil, or if non-nil, value must be a boolean. * **`archived`** value may be nil, or if non-nil, value must be a boolean. * **`alert-updates`**
PUT_:id_unsubscribeclj
## `PUT /api/alert/:id/unsubscribe` Unsubscribes a user from the given alert ##### PARAMS: * **`id`**
routesclj
Ring routes for api/alert: (POST_ PUT_:id GET_question_:id PUT_:id_unsubscribe GET_ DELETE_:id)
Ring routes for api/alert: (POST_ PUT_:id GET_question_:id PUT_:id_unsubscribe GET_ DELETE_:id)
cljdoc is a website building & hosting documentation for Clojure/Script libraries
× close