List report sections
package main
import ( "fmt" "net/http" "io")
func main() {
url := "https://api.wpengineapi.com/v1/site_reports/sections"
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/sections';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/sections \ --header 'Authorization: Basic <credentials>'Returns the available sections for a site report
Authorizations
Section titled “Authorizations ”Responses
Section titled “ Responses ”OK
object
Name of the report type
Type of resource the sections apply to
Available sections that can be included in the report
object
Internal identifier for the section
Human-readable name for the section
Display order of the section in the report
Preview image URL for the section
Footer link URL for the section
Group name referring to several related pages
Human-readable name of the section group
Whether the section is required in all reports
Example
{ "name": "siteReport", "resource_type": "site", "sections": [ { "name": "cover", "display_text": "Cover", "order": 1, "image_url": "https://storage.googleapis.com/sites_reports_static_images_bucket/preview-gallery-cover.png", "footer_url": "https://my.wpengine.com/installs/{install_name}", "group_name": "overview", "group_display_text": "Overview", "mandatory": true } ]}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