List report schedules
package main
import ( "fmt" "net/http" "io")
func main() {
url := "https://api.wpengineapi.com/v1/site_reports/schedules?site_id=example"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Basic <credentials>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close() body, _ := io.ReadAll(res.Body)
fmt.Println(res) fmt.Println(string(body))
}const url = 'https://api.wpengineapi.com/v1/site_reports/schedules?site_id=example';const options = {method: 'GET', headers: {Authorization: 'Basic <credentials>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url 'https://api.wpengineapi.com/v1/site_reports/schedules?site_id=example' \ --header 'Authorization: Basic <credentials>'Description
Reports can be scheduled to run monthly, weekly, or every two weeks. This endpoint returns all active report schedules for a given site, allowing you to manage and monitor when reports are generated automatically.
For monthly scheduling, set the Unit to MONTHLY and set the Frequency Value to the day of the month (1-31) when you want the report to run. For example, Unit = MONTHLY and Frequency Value = 15 will run the report on the 15th of every month. If you set a report to run on the 29th, 30th, or 31st and that date doesn’t exist in a given month, the report will run on the last day of that month. For instance, designating the 31st will result in the report running on February 28th (or 29th in leap years).
For weekly or bi-weekly scheduling, set the Unit to DAYS and then set the Frequency Value to 7 for weekly reports or 14 for reports to run every two weeks. The day of the week is determined by the next_scheduled_date value. For example, if the next_scheduled_date is a Tuesday and the Frequency Value is 7, then the report will run each week on Tuesday.
Authorizations
Section titled “Authorizations ”Parameters
Section titled “ Parameters ”Query Parameters
Section titled “Query Parameters ”Filter schedules by site ID
Responses
Section titled “ Responses ”OK
object
List of configured report schedules
object
Title of the scheduled report
Next date when the report will be automatically generated
Report generation frequency configuration
object
Frequency value. For DAYS, value is 7 or 14. For MONTHLY, value is the day of the month (1-31).
Frequency unit. DAYS indicates a Weekly or Bi-Weekly schedule. MONTHLY indicates a monthly schedule.
People who will receive the scheduled reports
object
Name of the recipient
Email address of the recipient
Report sections included in the schedule
object
Section identifier
Unique identifier for the schedule
UUID of the report template used for this schedule
Branding configuration applied to the report
object
Unique identifier for the branding configuration
Company name displayed on the report
Hex value of the color used on the report coversheet
URL of the company logo image
URL of the template preview image
Example
{ "schedules": [ { "title": "Weekly Site Report", "next_scheduled_date": "2026-06-18T00:00:00Z", "frequency": { "value": 7, "unit": "DAYS" }, "recipients": [ { "name": "Jane Smith", "email": "user@example.com" } ], "sections": [ { "name": "cover" } ], "uuid": "ed0f66dd-1a0a-4e87-919d-945b08bc230d", "template_uuid": "9fe01285-87cc-405b-9f2f-02cc1316bb63", "branding": { "uuid": "1ed3eaa4-b1d6-4b9f-96e5-9054c3cdaafd", "company_name": "My Agency", "brand_color": "#FF0000", "logo_url": "https://storage.googleapis.com/sites_reports_template_preview_and_logo_images_bucket/logo.png", "image_preview_url": "https://storage.googleapis.com/sites_reports_template_preview_and_logo_images_bucket/preview.png" } } ]}Bad Request
object
A message regarding the error that occurred on the server
(Optional) A URL where documentation regarding this specific error can be found
An array of error objects describing specific errors that arose when servicing the request
object
The name of the resource that was being processed when the error occurred
(Optional) The specific field associated with the error
(Optional) A type associated with the error. invalid_value, access_error, value_unavailable
(Optional) A machine code relating to the error that occurred with the field and resource
(Optional) A human-readable message relating to the error that occurred with the field and resource
Example
{ "message": "Invalid Site: Name cannot be empty.", "errors": [ { "resource": "Site", "field": "name", "type": "invalid_value", "code": "too_long", "message": "Name is too long (maximum is 40 characters)" } ]}Authentication Error
object
A message regarding the error that occurred on the server
(Optional) A URL where documentation regarding this specific error can be found
Example
{ "message": "Bad Credentials"}Not authorized
object
A message regarding the error that occurred on the server
(Optional) A URL where documentation regarding this specific error can be found
Example
{ "message": "You don't have permission to perform that action"}Not found
object
A message regarding the error that occurred on the server
(Optional) A URL where documentation regarding this specific error can be found
Example
{ "message": "Not Found"}Too many requests
Internal Server Error
object
A message regarding the error that occurred on the server
Example
{ "message": "An unexpected error occurred, please try again in a few minutes"}An invalid response was received from an upstream server
Service unavailable