Logs contain the holistic data on notifications and notification messages a target user receives. As for notifications, a Notification overview resource and Notification details resource contain information on how many notification messages have been sent out, when the notification arrived at the target user's channel, and how many users have clicked the message. Meanwhile, you can also retrieve all the Notification messages that a single target user has received from a specified time point.
These figures also can be monitors in the Logs page on Sendbird Dashboard.
Depending on the call, a response may contain different resources as follows.
A Notification message is an actual message that an end user receives as a result of a notification you've sent. Thus, the Notification message resource contains more data on the message and message event that each target user received. This is returned when requesting user logs.
The unique ID of the notification.
The template key of the notification.
The channel of the notification.
The key of the channel.
The type of the channel.
The delivery mode of the notification. Options: real-time, batch.
The title of the notification. If not specified, the value is null.
The tag of the notification. If not specified, the value is null.
The priority of the batch notification. Options: high, normal, low.
The data for the notification.
The status of the notification message. Valid values are
The unique URL of the channel where the message is sent to.
The label of the notification.
The template variables used to send the notification.
The event logs for the notification message.
Timestamp in milliseconds when the notification message was sent.
Timestamp in milliseconds when the notification message was marked as impression. (Default:
Timestamp in milliseconds when the notification message was marked as clicked. (Default:
The custom event logs for the notification message.
Timestamp in milliseconds when the notification message was marked by custom event topic.
List notification messages a user received
This API retrieves all the logs on notification messages that a user has received since the specified
Specifies the user ID to retrieve notification messages.
Specifies the channel key to retrieve notification messages.
Specifies the timestamp to be the reference point of the query in Unix milliseconds.
Specifies whether to include event logs in the response or not.
Specifies the number of previously sent messages to retrieve before. For example, if
Specifies the number of sent messages to retrieve after
Determines whether to sort the results in reverse chronological order. If set to
Determines whether to include only messages removed from the channel in the results. (Default:
If successful, this action returns a list of Notification message resources in the response body.