Get Site Alert Config

GET

This endpoint fetches your site specific Alert Configuration for the siteId and type provided in url.

Path parameters

siteIdlongRequired

typestringRequired

Response

This endpoint returns an object.

alertConfigurationTypestringOptional

The type of alert configuration

enabledbooleanOptional

Whether this alert is enabled

notifyHealthCoachbooleanOptional

Whether to notify the health coach when the alert is triggered

notifyPatientbooleanOptional

Whether to notify the patient when the alert is triggered

configobjectOptional

Alert configuration rules. Structure varies by alertConfigurationType.

notificationEmailslist of stringsOptional

List of emails to notify when alert is triggered

alertConfigType"bloodPressure"OptionalDefaults to bloodPressure

GET

1 curl https://app.impiloplatform.com/api/v3/alerts/configuration/site/1000000/type \
2      -H "Impilo-API-Key: <apiKey>"

200AlertConfigurationExample

1 {
2   "alertConfigurationType": "bloodPressure",
3   "enabled": true,
4   "notifyHealthCoach": true,
5   "notifyPatient": true,
6   "config": {
7     "rules": [
8       {
9         "severity": "MEDIUM",
10         "field": "systolic",
11         "type": "threshold",
12         "value": 140,
13         "operator": "gt"
14       },
15       {
16         "severity": "MEDIUM",
17         "field": "systolic",
18         "type": "relative_change",
19         "value": 20,
20         "direction": "increase"
21       }
22     ],
23     "_example": {
24       "key": "value"
25     }
26   },
27   "notificationEmails": [
28     "notificationEmail1@example.com",
29     "notificationEmail2@example.com"
30   ],
31   "alertConfigType": "bloodPressure"
32 }

Built with

1	curl https://app.impiloplatform.com/api/v3/alerts/configuration/site/1000000/type \
2	-H "Impilo-API-Key: <apiKey>"

1	{
2	"alertConfigurationType": "bloodPressure",
3	"enabled": true,
4	"notifyHealthCoach": true,
5	"notifyPatient": true,
6	"config": {
7	"rules": [
8	{
9	"severity": "MEDIUM",
10	"field": "systolic",
11	"type": "threshold",
12	"value": 140,
13	"operator": "gt"
14	},
15	{
16	"severity": "MEDIUM",
17	"field": "systolic",
18	"type": "relative_change",
19	"value": 20,
20	"direction": "increase"
21	}
22	],
23	"_example": {
24	"key": "value"
25	}
26	},
27	"notificationEmails": [
28	"notificationEmail1@example.com",
29	"notificationEmail2@example.com"
30	],
31	"alertConfigType": "bloodPressure"
32	}