API Research - Jobs and Templates Tables

[em-herrick]

Acceptance Criteria

We're looking for a back-end engineer to help the front-end with a bit of stock-taking research. For the following feature:

• [ ] Review the API structure of relevant APIs (Messages, Services, Stats, Quotas etc.)
• [ ] Document your findings and recommendations in a new markdown file in the docs/ directory

We'll be reviewing these together to determine our next steps for implementation work.

Implementation Sketch

When researching the API and documenting your findings, please keep these things in mind:

• [ ] What’s currently available in the API?
  • This could mean a couple of things: actual endpoints that already exist, and/or underlying parts of the data model that exist but are not exposed yet. Be sure to look at both!
• [ ] What might we be able to consolidate or clean up?
  • Again, take into account both the existing API endpoints and the underlying data model for things that exist but aren't currently exposed.
• [ ] What might we need to do/create?
  • Things to consider: is it just a new endpoint(s)? Do we need new data model properties that then need to be exposed (and if so, what kind of migration(s) might that entail)?
• [ ] What work might already be in flight and incomplete/not reviewed yet?
  • Be sure to check existing open PRs to see what might have been done already but isn't finished/tested/reviewed!
• [ ] What is an estimated level of effort for each feature based on the previous questions?
  • This is just a high level estimate, nothing super fancy.

Feature 2: Job activity:

This feature is similar to the batch jobs that we currently have on display on our current dashboard. Columns: File name, Status, Sender, Service name.

Sub feature: Search

I do not believe we currently have an endpoint for search on jobs within service name, all services, or user.

Possible inputs: Users can search by any of the column fields.

Sub feature: Pagination

I do not believe we currently have an endpoint for pagination on jobs within service name, all services, or user.

Possible endpoint: curl --location --globoff '{{base}}/service/{{service_id}}/job'

Feature 3: Template activity:

This feature pertains to templates. Columns include: Template name, the folder where the templates are located—if they exist—or default to the parent folder, last used, created by, and the count of times the template has been used.

Follow up question: Do we want to count the number of times a template has been used within a specific date range or throughout all time?

Possible endpoint: {{base}}/service/{{service_id}}/notifications/templates_usage/monthly?year={{year}} {{base}}/service/{{service_id}}/template-statistics?whole_days=7

Sub feature: Pagination

I do not believe we currently have an endpoint for pagination on jobs within service name, all services, or user.

[ccostino]

@A-Shumway42, we have this one assigned to you but we know a couple of other things are still in flight, and we're shifting this to the backlog as the data visualizations are a higher priority at the moment. All said, hold tight for now and we'll revisit this soon! 🙂