Read a Notification

Version 4.0.24.14

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
HTTP Request
path
HTTP Path
Expand HTTP Path definition...
alert_notification_id
string
ID of a notification

Response

200: It updates that the given alert notification has been read by the user

Datatype
Description
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

422: Validation Error

Datatype
Description
(object)
message
string
Error details
Expand ValidationErrorDetail definition...
field
string
Field with error
code
string
Error code
message
string
Error info message
documentation_url
string
Documentation link
documentation_url
string
Documentation link

429: Too Many Requests

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