WP Engine Site Reports API
The Site Reports API from WP Engine — 1 operation(s) for site reports.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/wpengine-site-reports-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
description: 'The API described in this document is subject to change.
'
version: 1.17.0
title: WP Engine Hosting Platform Account Site Reports API
termsOfService: https://wpengine.com/legal/terms-of-service/
servers:
- url: https://api.wpengineapi.com/v1
tags:
- name: Site Reports
paths:
/site_reports/templates:
get:
tags:
- Site Reports
summary: List report templates
description: '# Description
Returns a list of report templates available for Site Reports.
Templates define the structure, branding, and sections included in generated reports.
'
operationId: listSiteReportTemplates
parameters:
- $ref: '#/components/parameters/authorization'
- name: account_id
in: query
description: Account ID to filter templates. This parameter is required.
required: true
x-example: eeda3227-9a39-46ae-9e14-20958bb4e6c9
schema:
type: string
format: uuid
responses:
'200':
description: List of report templates
content:
application/json:
schema:
type: object
properties:
templates:
type: array
items:
$ref: '#/components/schemas/Template'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequestErrorResponse'
'401':
description: Authentication Error
content:
application/json:
schema:
$ref: '#/components/schemas/AuthenticationErrorResponse'
'403':
description: Not authorized
content:
application/json:
schema:
$ref: '#/components/schemas/ForbiddenErrorResponse'
'404':
description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/NotFoundErrorResponse'
'429':
$ref: '#/components/schemas/TooManyRequestsOperation'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerErrorResponse'
'502':
$ref: '#/components/schemas/BadGatewayOperation'
'503':
$ref: '#/components/schemas/ServiceUnavailableOperation'
security:
- basicAuth: []
x-amazon-apigateway-integration:
uri: https://my.wpengine.com/capi/v1/site_reports/templates
responses:
'200':
statusCode: '200'
'400':
statusCode: '400'
'401':
statusCode: '401'
'403':
statusCode: '403'
'404':
statusCode: '404'
'429':
statusCode: '429'
'500':
statusCode: '500'
'502':
statusCode: '502'
'503':
statusCode: '503'
default:
statusCode: '500'
requestParameters:
integration.request.header.X-Request-ID: context.requestId
integration.request.header.sourceIp: context.identity.sourceIp
integration.request.header.authorization: method.request.header.Authorization
integration.request.querystring.account_id: method.request.querystring.account_id
passthroughBehavior: when_no_match
httpMethod: GET
type: http
components:
schemas:
InternalServerErrorResponse:
type: object
required:
- message
properties:
message:
type: string
description: A message regarding the error that occurred on the server
example: An unexpected error occurred, please try again in a few minutes
Template:
type: object
required:
- template_uuid
- template_name
properties:
template_uuid:
type: string
format: uuid
example: 123e4567-e89b-12d3-a456-426614174000
description: Unique identifier for the template
template_name:
type: string
maxLength: 100
example: Site Report
description: Display name of the template
description:
type: string
example: Comprehensive site performance and analytics report
description: Detailed description of what the template includes
company_name:
type: string
example: WP Engine
description: Company name displayed on the report
brand_colour:
type: string
example: '#0ECAD4'
description: Brand color used in the report (hex format)
logo_url:
type: string
format: uri
example: https://storage.googleapis.com/crs-assets/logos/wpengine-logo.png
description: URL to the company logo
preview_image_url:
type: string
format: uri
example: https://storage.googleapis.com/crs-assets/previews/site-report-preview.png
description: URL to template preview image
sections:
type: array
items:
type: object
properties:
name:
type: string
example: cover
example:
- name: cover
- name: overview
- name: usage
- name: themes
description: List of sections included in this template
created_at:
type: string
format: date-time
example: '2024-01-15T10:30:00Z'
description: Timestamp when the template was created
updated_at:
type: string
format: date-time
example: '2024-03-20T14:45:00Z'
description: Timestamp when the template was last updated
description: Report template defining structure and branding for generated reports
ServiceUnavailableOperation:
description: Service unavailable
BadGatewayOperation:
description: An invalid response was received from an upstream server
NotFoundErrorResponse:
type: object
required:
- message
properties:
message:
type: string
description: A message regarding the error that occurred on the server
example: Not Found
documentation_url:
type: string
description: (Optional) A URL where documentation regarding this specific error can be found
ResourceError:
type: object
required:
- resource
- field
- type
- code
- message
properties:
resource:
type: string
description: The name of the resource that was being processed when the error occurred
example: Site
field:
type: string
description: (Optional) The specific field associated with the error
example: name
type:
type: string
description: (Optional) A type associated with the error. `invalid_value`, `access_error`, `value_unavailable`
example: invalid_value
code:
type: string
description: (Optional) A machine code relating to the error that occurred with the field and resource
example: too_long
message:
type: string
description: (Optional) A human-readable message relating to the error that occurred with the field and resource
example: Name is too long (maximum is 40 characters)
AuthenticationErrorResponse:
type: object
required:
- message
properties:
message:
type: string
description: A message regarding the error that occurred on the server
example: Bad Credentials
documentation_url:
type: string
description: (Optional) A URL where documentation regarding this specific error can be found
BadRequestErrorResponse:
type: object
required:
- message
properties:
message:
type: string
description: A message regarding the error that occurred on the server
example: 'Invalid Site: Name cannot be empty.'
documentation_url:
type: string
description: (Optional) A URL where documentation regarding this specific error can be found
errors:
type: array
description: An array of error objects describing specific errors that arose when servicing the request
items:
$ref: '#/components/schemas/ResourceError'
TooManyRequestsOperation:
description: Too many requests
ForbiddenErrorResponse:
type: object
required:
- message
properties:
message:
type: string
description: A message regarding the error that occurred on the server
example: You don't have permission to perform that action
documentation_url:
type: string
description: (Optional) A URL where documentation regarding this specific error can be found
parameters:
authorization:
name: Authorization
in: header
schema:
type: string
format: uuid
securitySchemes:
basicAuth:
type: http
scheme: basic
description: 'API username and password from Portal''s API Access page: https://my.wpengine.com/api_access'