API Reference

Generate a maintenance report

post
https://public-api.wp-umbrella.com/projects//reports

Generates a maintenance report covering the requested period, using the report template linked to the project, then emails it to its recipients.

Generation and sending both run in the background: the response acknowledges the request with a report in the PENDING state, and GET /projects/{projectId}/reports/{reportId} tells when it reaches FINISHED or ERROR.

The period cannot exceed 366 days, which is what a yearly report needs. The number of reports a project can generate in a day is capped, and going over it answers 429.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
integer
required

Project ID

Body Params
string
required

First day of the reported period, formatted as YYYY-MM-DD

string
required

Last day of the reported period, formatted as YYYY-MM-DD

emails
array of strings

Recipients of the report. When omitted, the recipients configured on the report template are used.

emails
Responses

Updated 23 days ago

Did this page help you?
Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 23 days ago

Did this page help you?