Personalized Alerts API
Use APIs to manage personalized alerts in your tenant.
Access requirements
To use APIs, you must have a Visier account and authenticate. For more information about authenticating, see API Authentication.
Permission with these capabilities: Set and View Alerts
Reach out to your administrator for access.
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 users and user groups. Alerts respect a user's data security. Users within the same user group may see different data due to their assigned permissions.
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 daily, weekly, or none. If weekly, users set the day of week to send the email. Visier starts processing email digests at 12:00 AM Coordinated Universal Time (UTC). Due to processing volume, it may take some time for users to receive the email.
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