Personalized Alerts API
Use APIs to manage personalized alerts in your tenant.
Note: Alpha This API is in alpha. While in alpha, APIs may change in a breaking way without notice; functionality may be removed, and no deprecation notices will be issued. If you are interested in using this API, please contact your
Who can use this feature?
To use the APIs, you must have a Visier account with a profile that has the API capability. If you don't have an account, contact your administrator. They will create an account for you with permissions that allow you to view data.
In addition to an API profile, your API user must have the following permission capability:
- Set and View Alerts
Not sure if you have this feature or capability? Reach out to your administrator.
Overview
Use personalized alerts to define a metric threshold that, if exceeded, notifies you of the metric value. For example, if you want to be notified any time your Resignation Rate exceeds 5%, set up a personalized alert. Users can set up their own personalized alerts and administrators can create alerts for user groups.
Alerts evaluate every time a new data version is available. If the metric threshold is exceeded, the alert triggers. When triggered, the alert shows up in a user's Home room and is sent to the user in an email digest. Each user can configure the frequency of their email digest, such as weekly or monthly.
For more information, see Personalized Alerts.
With this API, you can:
- Retrieve your personalized alerts
- Create a new alert
- Update an alert
- Delete an alert
- Enable or disable an alert
- Retrieve all active alert notifications