v1

latestOpenAPI 3.0.12026-07-2376273191.5 KB
Notification Logs

Retrieve notification logs

Retrieve notification logs based on the provided filters. API key must have the View Notification logs permission.

get/api/v1/notifications/logs

Query parameters

notificationRunIdsinteger[]

The unique identifier of the notification run that this log is associated with.

notificationTypesstring[]

The type of notification.

statusesstring[]

The status of the notification.

recipientTypesstring[]

The type of the notification recipient.

recipientEmailsstring[]

The email address that this notification was sent to.

recipientEntityIdsinteger[]

The unique identifiers of the entities that the notifications were sent to.

recipientChannelsstring[]

The channel in Slack or MS Teams where the notification was sent.

mediumsstring[]

The medium used to send the notification.

ignoredReasonsstring[]

The reason why a notification was ignored.

failedReasonsstring[]

The reason why a notification failed to send.

fromDatestring date-time

The ISO date and time to start the search from.

untilDatestring date-time

The ISO date and time to end the search at.

pageSizeinteger required

Number of results to return per page, between 1 and 1000. Default 250.

pageinteger required

Page number to return, 0-indexed. Default 0.

orderBy'ASC' | 'DESC'

Sort the results ascending or descending.

Response

Successfully retrieved notification logs

pageinteger required

Current page number, 0-indexed

totalinteger required

Total number of results

totalPagesinteger required

Total number of pages