Version 4.0.25.20 (latest)
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
lock
string
ID of the notification
alert_condition_id
lock
string
ID of the alert
user_id
lock
string
ID of the user
is_read
boolean
Read state of the notification
field_value
lock
number
The value of the field on which the alert condition is set
threshold_value
lock
number
The value of the threshold which triggers the alert notification
ran_at
lock
string
The time at which the alert query ran
Expand MobilePayload definition...
title
lock
string
Title of the alert
alert_id
lock
string
ID of the alert
investigative_content_id
lock
string
ID of the investigative content
dashboard_name
lock
string
Name of the dashboard on which the alert has been set
dashboard_id
lock
string
ID of the dashboard on which the alert has been set
query_slug
lock
string
Slug of the query which runs the alert queries.
notification_type
lock
string
The type of notification, 'email' or 'slack'
400: Bad Request
Datatype
Description
(object)
message
lock
string
Error details
documentation_url
lock
string
Documentation link
404: Not Found
Datatype
Description
(object)
message
lock
string
Error details
documentation_url
lock
string
Documentation link
429: Too Many Requests
Datatype
Description
(object)
message
lock
string
Error details
documentation_url
lock
string
Documentation link
