New API endpoint: Failed and delivered messages by month (notification_status)

[ccostino]

We need a new API endpoint that will provide us the following information: the number of failed and delivered messages by month (notification_status)

As a part of this work, we'll also have to come up with an approach to how we want to structure and organize these new endpoints. Ideally this would be an ADR, but it'd be helpful to have a working example to review and discuss as a team so we can see what direction we want to go in.

As discussed, these are some of the considerations we've come up with for the new endpoints:

• Keep them well-focused and well-scoped so they're specific and only working with/retrieving the data they're intended for.
• Keep endpoints focused on a specific object (e.g., data related to just a service; data related to just a user; etc.).
• Make them as flexible as possible:
  • If someone is requesting data about a service, then the endpoint ought to have something like service/<service_id> in its route to specify the service
  • Conversely, if someone is trying to sort, filter, etc., data on that endpoint, e.g., by a date or a time window, then that should be a query parameter that is passed in instead of being hardcoded anywhere

Lastly, note that creating the new endpoint in the API may not be enough! We will also likely have to add support for it in one of the API clients in the admin.

Implementation Sketch and Acceptance Criteria

• Create the new endpoint to support the frontend data visualization in a place that makes sense
  • Create the route, view function, JSON serialization, and any support methods necessary
• Add tests for the new endpoint
• If needed, add support for the new endpoint on the admin side in the most appropriate API client in the admin project
  • Add tests there as well as needed

Security Considerations

• Be mindful of the data that we're going to expose with the new endpoint; by and large it should be what's already visible, just not grouped together and/or formatted as we need it yet, but any new data we need to double check that it's appropriate to expose and share.
• Make sure any permissions checks and/or decorators used for other endpoints are also on this new endpoint to maintain the proper access to the new endpoint.