Version 4.0.24.18 (latest)
Reads a Notification
The endpoint marks a given alert notification as read by the user, in case it wasn't already read. The AlertNotification model is updated for this purpose. It returns the notification as a response.
Request
PATCH
/alert_notifications/{alert_notification_id}
Datatype
Description
Request
path
Expand HTTP Path definition...
alert_notification_id
ID of a notification
Response
200: It updates that the given alert notification has been read by the user
Datatype
Description
(object)
notification_id
lock
ID of the notification
alert_condition_id
lock
ID of the alert
user_id
lock
ID of the user
is_read
Read state of the notification
field_value
lock
The value of the field on which the alert condition is set
threshold_value
lock
The value of the threshold which triggers the alert notification
ran_at
lock
The time at which the alert query ran
alert
lock
It contains the details needed for mobile alerts payload
Expand MobilePayload definition...
title
lock
Title of the alert
alert_id
lock
ID of the alert
investigative_content_id
lock
ID of the investigative content
dashboard_name
lock
Name of the dashboard on which the alert has been set
dashboard_id
lock
ID of the dashboard on which the alert has been set
query_slug
lock
Slug of the query which runs the alert queries.
400: Bad Request
Datatype
Description
(object)
message
lock
Error details
documentation_url
lock
Documentation link
404: Not Found
Datatype
Description
(object)
message
lock
Error details
documentation_url
lock
Documentation link
422: Validation Error
Datatype
Description
(object)
message
lock
Error details
errors
Expand ValidationErrorDetail definition...
field
lock
Field with error
code
lock
Error code
message
lock
Error info message
documentation_url
lock
Documentation link
documentation_url
lock
Documentation link
429: Too Many Requests
Datatype
Description
(object)
message
lock
Error details
documentation_url
lock
Documentation link