Alert Notifications

Version 4.0.24.12

Alert Notifications.

The endpoint returns all the alert notifications received by the user on email in the past 7 days. It also returns whether the notifications have been read by the user.

Request

GET /alert_notifications
Datatype
Description
Request
HTTP Request
query
HTTP Query
Expand HTTP Query definition...
limit
integer
(Optional) Number of results to return (used with `offset`).
offset
integer
(Optional) Number of results to skip before returning any (used with `limit`).

Response

200: It shows all the alert notifications received by the user on email.

Datatype
Description
(array)
notification_id
string
ID of the notification
alert_condition_id
string
ID of the alert
user_id
string
ID of the user
is_read
boolean
Read state of the notification
field_value
number
The value of the field on which the alert condition is set
threshold_value
number
The value of the threshold which triggers the alert notification
ran_at
string
The time at which the alert query ran
alert
It contains the details needed for mobile alerts payload
Expand MobilePayload definition...
title
string
Title of the alert
alert_id
string
ID of the alert
investigative_content_id
string
ID of the investigative content
dashboard_name
string
Name of the dashboard on which the alert has been set
dashboard_id
string
ID of the dashboard on which the alert has been set
query_slug
string
Slug of the query which runs the alert queries.

400: Bad Request

Datatype
Description
(object)
message
string
Error details
documentation_url
string
Documentation link

404: Not Found

Datatype
Description
(object)
message
string
Error details
documentation_url
string
Documentation link

429: Too Many Requests

Datatype
Description
(object)
message
string
Error details
documentation_url
string
Documentation link