Personalized Alerts API Code Samples

Selection of code samples that demonstrate the use of the Personalized Alerts API. Copy and edit these code samples to suit your needs.

When using the code samples, remember to replace:

{vanity_name} with your tenant name
{api_key} with your API key
{security_token} with a valid security token

These code samples may not include all available parameters and request body fields for each endpoint. For the endpoint's full request schema, see "Personalized Alerts" in API Reference.

Retrieve personalized alerts

Use this sample request to retrieve all the personalized alerts you have access to.

Copy

cURL sample request: Retrieve all personalized alerts

1
2
3
curl -X GET --url 'https://{vanity_name}.api.visier.io/v1alpha/alerts' \
-H 'apikey:{api_key}' \
-H 'Cookie:VisierASIDToken={security_token}'

The response returns your personalized alerts.

View sample response

Copy

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
{
    "ownedAlerts": [
        {
            "alertId": "00000000-0000-0000-0000-000000000000",
            "triggerCriteria": {
                "groupedMetricValueThreshold": {
                    "metric": {
                        "id": "Exit_Model.Rate.Exit",
                        "parameterValues": [],
                        "timeHandling": {
                            "trailingPeriods": {
                                "periodType": "M",
                                "periodsBack": 6
                            }
                        }
                    },
                    "filters": [
                        {
                            "conceptReference": {
                                "id": "Employee.isCriticalEmployee",
                                "qualifyingPath": "Employee_Exit.Employee"
                            }
                        }
                    ],
                    "dimension": {
                        "id": "Organization_Hierarchy",
                        "qualifyingPath": "Employee_Exit.Employee"
                    },
                    "relativeTimePeriod": {
                        "allowPartialPeriod": false,
                        "periodType": "QUARTER",
                        "periodCount": 1,
                        "direction": "BACKWARD"
                    },
                    "ruleSet": {
                        "compareTo": {
                            "noComparison": {}
                        },
                        "rules": [
                            {
                                "relativeToValueRule": {
                                    "rulePredicate": "GREATER_THAN",
                                    "comparand": 0.1
                                }
                            }
                        ]
                    }
                }
            },
            "displayName": "Critical Employee Turnover",
            "isEnabledForUser": true
        }
    ],
    "sharedAlerts": [
        {
            "alertId": "00000000-0000-0000-0000-000000000000",
            "triggerCriteria": {
                "groupedMetricValueThreshold": {
                    "metric": {
                        "id": "Exit_Model.Rate.Exit",
                        "parameterValues": [],
                        "timeHandling": {
                            "trailingPeriods": {
                                "periodType": "M",
                                "periodsBack": 6
                            }
                        }
                    },
                    "filters": [
                        {
                            "conceptReference": {
                                "id": "Employee.isCriticalEmployee",
                                "qualifyingPath": "Employee_Exit.Employee"
                            }
                        }
                    ],
                    "dimension": {
                        "id": "Organization_Hierarchy",
                        "qualifyingPath": "Employee_Exit.Employee"
                    },
                    "relativeTimePeriod": {
                        "allowPartialPeriod": true,
                        "periodType": "QUARTER",
                        "periodCount": 1,
                        "direction": "BACKWARD"
                    },
                    "ruleSet": {
                        "compareTo": {
                            "sameMetricOtherTime": {
                                "timePeriod": {
                                    "samePeriodPreviousYear": {}
                                }
                            }
                        },
                        "rules": [
                            {
                                "relativeToValueRule": {
                                    "rulePredicate": "GREATER_THAN",
                                    "comparand": 0.02
                                }
                            }
                        ]
                    }
                }
            },
            "displayName": "Studio Critical Employee Turnover alert",
            "isEnabledForUser": true
        }
    ]
}

Retrieve a personalized alert

Use this sample request to retrieve a specific personalized alert.

Copy

cURL sample request: Retrieve alert 00000000-0000-0000-0000-000000000000

1
2
3
curl -X GET --url 'https://{vanity_name}.api.visier.io/v1alpha/alerts/00000000-0000-0000-0000-000000000000' \
-H 'apikey:{api_key}' \
-H 'Cookie:VisierASIDToken={security_token}'

The response returns the personalized alert details.

View sample response

Copy

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
{
    "alertId": "00000000-0000-0000-0000-000000000000",
    "triggerCriteria": {
        "groupedMetricValueThreshold": {
            "metric": {
                "id": "Exit_Model.Rate.Exit",
                "parameterValues": [],
                "timeHandling": {
                    "trailingPeriods": {
                        "periodType": "M",
                        "periodsBack": 6
                    }
                }
            },
            "filters": [
                {
                    "conceptReference": {
                        "id": "Employee.isCriticalEmployee",
                        "qualifyingPath": "Employee_Exit.Employee"
                    }
                }
            ],
            "dimension": {
                "id": "Organization_Hierarchy",
                "qualifyingPath": "Employee_Exit.Employee"
            },
            "relativeTimePeriod": {
                "allowPartialPeriod": true,
                "periodType": "QUARTER",
                "periodCount": 1,
                "direction": "BACKWARD"
            },
            "ruleSet": {
                "compareTo": {
                    "sameMetricOtherTime": {
                        "timePeriod": {
                            "samePeriodPreviousYear": {}
                        }
                    }
                },
                "rules": [
                    {
                        "relativeToValueRule": {
                            "rulePredicate": "GREATER_THAN",
                            "comparand": 0.02
                        }
                    }
                ]
            }
        }
    },
    "displayName": "Studio alert",
    "isEnabledForUser": true
}

Create a personalized alert

Use this sample request to create a new personalized alert.

Copy

cURL sample request: Create an alert

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
curl -X POST --url 'https://{vanity_name}.api.visier.io/v1alpha/alerts' \
-H 'apikey:{api_key}' \
-H 'Cookie:VisierASIDToken={security_token}' \
-H 'Content-Type: application/json' \
-d '{
    "displayName": "API Critical Employee Alert",
    "triggerCriteria": {
        "groupedMetricValueThreshold": {
            "metric": {
                "id": "Exit_Model.Rate.Exit",
                "parameterValues": [],
                "timeHandling": {
                    "trailingPeriods": {
                        "periodType": "M",
                        "periodsBack": 6
                    }
                }
            },
            "filters": [
                {
                    "conceptReference": {
                        "id": "Employee.isCriticalEmployee",
                        "qualifyingPath": "Employee_Exit.Employee"
                    }
                }
            ],
            "dimension": {
                "id": "Organization_Hierarchy",
                "qualifyingPath": "Employee_Exit.Employee"
            },
            "relativeTimePeriod": {
                "allowPartialPeriod": false,
                "periodType": "QUARTER",
                "periodCount": 1,
                "direction": "BACKWARD"
            },
            "ruleSet": {
                "compareTo": {
                    "noComparison": {}
                },
                "rules": [
                    {
                        "relativeToValueRule": {
                            "rulePredicate": "GREATER_THAN",
                            "comparand": 0.1
                        }
                    }
                ]
            }
        }
    }
}'

The response returns the personalized alert details.

View sample response

Copy

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
{
    "alertId": "00000000-0000-0000-0000-000000000000",
    "triggerCriteria": {
        "groupedMetricValueThreshold": {
            "metric": {
                "id": "Exit_Model.Rate.Exit",
                "parameterValues": [],
                "timeHandling": {
                    "trailingPeriods": {
                        "periodType": "M",
                        "periodsBack": 6
                    }
                }
            },
            "filters": [
                {
                    "conceptReference": {
                        "id": "Employee.isCriticalEmployee",
                        "qualifyingPath": "Employee_Exit.Employee"
                    }
                }
            ],
            "dimension": {
                "id": "Organization_Hierarchy",
                "qualifyingPath": "Employee_Exit.Employee"
            },
            "relativeTimePeriod": {
                "allowPartialPeriod": false,
                "periodType": "QUARTER",
                "periodCount": 1,
                "direction": "BACKWARD"
            },
            "ruleSet": {
                "compareTo": {
                    "noComparison": {}
                },
                "rules": [
                    {
                        "relativeToValueRule": {
                            "rulePredicate": "GREATER_THAN",
                            "comparand": 0.1
                        }
                    }
                ]
            }
        }
    },
    "displayName": "API Critical Employee Alert",
    "isEnabledForUser": true
}

Update a personalized alert

Use this sample request to update an existing personalized alert.

Copy

cURL sample request: Update alert 00000000-0000-0000-0000-000000000000

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
curl -X PUT --url 'https://{vanity_name}.api.visier.io/v1alpha/alerts/00000000-0000-0000-0000-000000000000' \
-H 'apikey:{api_key}' \
-H 'Cookie:VisierASIDToken={security_token}' \
-H 'Content-Type: application/json' \
-d '{
    "displayName": "Updated API Critical Employee Alert",
    "triggerCriteria": {
        "groupedMetricValueThreshold": {
            "metric": {
                "id": "Exit_Model.Rate.Exit",
                "parameterValues": [],
                "timeHandling": {
                    "trailingPeriods": {
                        "periodType": "M",
                        "periodsBack": 6
                    }
                }
            },
            "filters": [
                {
                    "conceptReference": {
                        "id": "Employee.isCriticalEmployee",
                        "qualifyingPath": "Employee_Exit.Employee"
                    }
                }
            ],
            "dimension": {
                "id": "Organization_Hierarchy",
                "qualifyingPath": "Employee_Exit.Employee"
            },
            "relativeTimePeriod": {
                "allowPartialPeriod": false,
                "periodType": "QUARTER",
                "periodCount": 1,
                "direction": "BACKWARD"
            },
            "ruleSet": {
                "compareTo": {
                    "noComparison": {}
                },
                "rules": [
                    {
                        "relativeToValueRule": {
                            "rulePredicate": "GREATER_THAN",
                            "comparand": 0.1
                        }
                    }
                ]
            }
        }
    }
}'

The response returns the personalized alert details.

View sample response

Copy

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
{
    "alertId": "00000000-0000-0000-0000-000000000000",
    "triggerCriteria": {
        "groupedMetricValueThreshold": {
            "metric": {
                "id": "Exit_Model.Rate.Exit",
                "parameterValues": [],
                "timeHandling": {
                    "trailingPeriods": {
                        "periodType": "M",
                        "periodsBack": 6
                    }
                }
            },
            "filters": [
                {
                    "conceptReference": {
                        "id": "Employee.isCriticalEmployee",
                        "qualifyingPath": "Employee_Exit.Employee"
                    }
                }
            ],
            "dimension": {
                "id": "Organization_Hierarchy",
                "qualifyingPath": "Employee_Exit.Employee"
            },
            "relativeTimePeriod": {
                "allowPartialPeriod": false,
                "periodType": "QUARTER",
                "periodCount": 1,
                "direction": "BACKWARD"
            },
            "ruleSet": {
                "compareTo": {
                    "noComparison": {}
                },
                "rules": [
                    {
                        "relativeToValueRule": {
                            "rulePredicate": "GREATER_THAN",
                            "comparand": 0.1
                        }
                    }
                ]
            }
        }
    },
    "displayName": "Updated API Critical Employee Alert",
    "isEnabledForUser": true
}

Enable or disable a personalized alert

Use this sample request to disable an existing personalized alert.

Copy

cURL sample request: Disable alert 00000000-0000-0000-0000-000000000000

1
2
3
4
5
6
7
curl -X PUT --url 'https://{vanity_name}.api.visier.io/v1alpha/alerts/00000000-0000-0000-0000-000000000000' \
-H 'apikey:{api_key}' \
-H 'Cookie:VisierASIDToken={security_token}' \
-H 'Content-Type: application/json' \
-d '{
    "status": "PAUSED"
}'

The response returns the personalized alert's status.

View sample response

Copy

1
2
3
{
    "status": "PAUSED"
}

Delete a personalized alert

Use this sample request to delete an existing personalized alert.

Copy

cURL sample request: Delete alert 00000000-0000-0000-0000-000000000000

1
2
3
curl -X DELETE --url 'https://{vanity_name}.api.visier.io/v1alpha/alerts/00000000-0000-0000-0000-000000000000' \
-H 'apikey:{api_key}' \
-H 'Cookie:VisierASIDToken={security_token}'

The response returns the deleted personalized alert's ID.

View sample response

Copy

1
2
3
{
    "alertId": "00000000-0000-0000-0000-000000000000"
}

Retrieve personalized alerts notifications

Use this sample request to retrieve all the notifications for your personalized alerts.

Copy

cURL sample request: Retrieve alert notifications

1
2
3
curl -X GET --url 'https://{vanity_name}.api.visier.io/v1alpha/notifications' \
-H 'apikey:{api_key}' \
-H 'Cookie:VisierASIDToken={security_token}'

The response returns any notifications for your personalized alerts in the last 30 days, including the criteria that triggered the alert.

View sample response

Copy

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
{
    "notifications": [{
            "alertNotificationId": "00000000-0000-0000-0000-000000000000",
            "alertId": "00000000-0000-0000-0000-000000000000",
            "createdDate": "1755110082092",
            "alertDetails": {
                "triggerType": "DV_UPDATE",
                "triggerCriteria": {
                    "groupedMetricValueThreshold": {
                        "metric": {
                            "id": "Exit_Model.Rate.Exit",
                            "parameterValues": [],
                            "timeHandling": {
                                "trailingPeriods": {
                                    "periodType": "M",
                                    "periodsBack": 6
                                }
                            }
                        },
                        "filters": [
                            {
                                "conceptReference": {
                                    "id": "Employee.isCriticalEmployee",
                                    "qualifyingPath": "Employee_Exit.Employee"
                                }
                            }
                        ],
                        "dimension": {
                            "id": "Organization_Hierarchy",
                            "qualifyingPath": "Employee_Exit.Employee"
                        },
                        "relativeTimePeriod": {
                            "allowPartialPeriod": false,
                            "periodType": "QUARTER",
                            "periodCount": 1,
                            "direction": "BACKWARD"
                        },
                        "ruleSet": {
                            "compareTo": {
                                "noComparison": {}
                            },
                            "rules": [
                                {
                                    "relativeToValueRule": {
                                        "rulePredicate": "GREATER_THAN",
                                        "comparand": 0.1
                                    }
                                }
                            ]
                        }
                    }
                }
            },
            "resultInfo": [],
            "resultType": "NOMINAL"
        },
        {
            "alertNotificationId": "00000000-0000-0000-0000-000000000000",
            "alertId": "00000000-0000-0000-0000-000000000000",
            "createdDate": "1755108543010",
            "alertDetails": {
                "triggerType": "DV_UPDATE",
                "triggerCriteria": {
                    "groupedMetricValueThreshold": {
                        "metric": {
                            "id": "Exit_Model.Rate.Exit",
                            "parameterValues": [],
                            "timeHandling": {
                                "trailingPeriods": {
                                    "periodType": "M",
                                    "periodsBack": 6
                                }
                            }
                        },
                        "filters": [
                            {
                                "conceptReference": {
                                    "id": "Employee.isCriticalEmployee",
                                    "qualifyingPath": "Employee_Exit.Employee"
                                }
                            }
                        ],
                        "dimension": {
                            "id": "Organization_Hierarchy",
                            "qualifyingPath": "Employee_Exit.Employee"
                        },
                        "relativeTimePeriod": {
                            "allowPartialPeriod": false,
                            "periodType": "QUARTER",
                            "periodCount": 1,
                            "direction": "BACKWARD"
                        },
                        "ruleSet": {
                            "compareTo": {
                                "noComparison": {}
                            },
                            "rules": [
                                {
                                    "relativeToValueRule": {
                                        "rulePredicate": "GREATER_THAN",
                                        "comparand": 0.1
                                    }
                                }
                            ]
                        }
                    }
                }
            },
            "resultInfo": [
                {
                    "memberResult": {
                        "memberId": "[Hierarchy].[-1].[Office of CEO]",
                        "displayName": "BlueSphere",
                        "value": 0.3333333333333333,
                        "formattedValue": "33.3%"
                    }
                },
                {
                    "memberResult": {
                        "memberId": "[Hierarchy].[-1].[Finance]",
                        "displayName": "Finance",
                        "value": 0.12931034482758622,
                        "formattedValue": "12.9%"
                    }
                },
                {
                    "memberResult": {
                        "memberId": "[Hierarchy].[-1].[Product]",
                        "displayName": "Product",
                        "value": 0.10714285714285714,
                        "formattedValue": "10.7%"
                    }
                }
            ],
            "resultType": "TRIGGERED"
        }]
}