Get a daily communication event report

Overview

Use this endpoint to get a daily report of events relating to in-app messages and push notifications that you have previously sent to NHS App users.

An event will be included in this report detailing the outcome of attempting to send each communication to each individual recipient, for each channel (push notification or in-app message). Additionally, for in-app messages only, an event will be included in this report if and when the recipient reads the message.

The information provided by this endpoint is generated by a daily batch process. Note that events in the report may pertain to communication requests that were submitted on earlier days.

Pagination

To avoid returning excessively large response bodies, the results may be split across multiple pages. On retrieving the response for the first page of results, the Link header should be inspected to determine whether any additional pages of results exist. If so, these can be retrieved by making additional request(s) with the optional page parameter specified.