Notification Reports

Retrieve the report of a notification within an organization


Response body

PropertyDescription
firstPageUriURI of first page
lastPageUriURI of last page
page.pageSizeMax results for current page
page.startIndex of the first result in current page
page.confirmedConfirmation status (true/false)
page.data[0].idID of the current record
page.data[0].notificationIdID of the notification
page.data[0].contactIdID of the contact
page.data[0].resultResult of the notification
page.data[0].attemptTimeTimestamp when notification was attempted
page.data[0].firstAttemptTimeTimestamp of first attempt
page.data[0].fullNameFull name
page.data[0].firstNameFirst name
page.data[0].lastNameLast name
page.data[0].attemptnumber of attempts
page.data[0].externalIdEmail address
page.data[0].createdIdTimestamp when notification was created
page.data[0].callResultByPaths.journalIdJournal ID
page.data[0].callResultByPaths.attemptIdID of the notification attempt
page.data[0].callResultByPaths.attemptOrderOrder of the notification attempt
page.data[0].callResultByPaths.attemptTimeTimestamp of the attempted notification
page.data[0].callResultByPaths.waitTimeWait time
page.data[0].callResultByPaths.countryCodeCountry code of the notification
page.data[0].callResultByPaths.cycleSeqCycle sequence
page.data[0].callResultByPaths.pathType of notification (email, sms, etc...)
page.data[0].callResultByPaths.pathTextaddress of the path (email address, phone number, etc..)
page.data[0].callResultByPaths.callResultresult of the notification
page.data[0].callResultByPaths.firstNameFirst name of recipient
page.data[0].callResultByPaths.lastNameLast name of recipient
page.data[0].callResultByPaths.confirmedConfirmation status (true/false)
totalCountTotal count of notifications returned
totalPageCountNumber of pages for query
currentPageNoCurrent page number

Error Messages

statusmessage
400Missing or invalid request input
401Invalid or missing credentials
500Internal Error
Language
Authorization
:
URL
Click Try It! to start a request and see the response here!