Get account level usage summary
package main
import ( "fmt" "net/http" "io")
func main() {
url := "https://api.wpengineapi.com/v1/accounts/eeda3227-9a39-46ae-9e14-20958bb4e6c9/usage/summary"
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/accounts/eeda3227-9a39-46ae-9e14-20958bb4e6c9/usage/summary';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/accounts/eeda3227-9a39-46ae-9e14-20958bb4e6c9/usage/summary \ --header 'Authorization: Basic <credentials>'Get the usage summary over a time period for the specificied account. The default response is a summary of the
last 30 days. The optional first_date and last_date arguments can be specified to retrieve a summary over
a custom date range. Both arguments must be provided and the range cannot exceed 31 days.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”ID of account
Example
eeda3227-9a39-46ae-9e14-20958bb4e6c9Query Parameters
Section titled “Query Parameters”The start date for the requested metrics range (inclusive).
Format: YYYY-mm-dd. Cannot be older than 13 months.
If first_date is provided, last_date must also be provided.
The end date for the requested metrics range (inclusive).
Format: YYYY-mm-dd.
If last_date is provided, first_date must also be provided.
Responses
Section titled “Responses”Success
A rollup of usage metrics.
object
A metric rollup.
object
The average value of the metric.
The total sum value of the metric.
The latest information.
object
The date (ISO 8601).
The value.
A metric rollup.
object
The average value of the metric.
The total sum value of the metric.
The latest information.
object
The date (ISO 8601).
The value.
A metric rollup.
object
The average value of the metric.
The total sum value of the metric.
The latest information.
object
The date (ISO 8601).
The value.
A metric rollup.
object
The average value of the metric.
The total sum value of the metric.
The latest information.
object
The date (ISO 8601).
The value.
A metric rollup.
object
The average value of the metric.
The total sum value of the metric.
The latest information.
object
The date (ISO 8601).
The value.
A metric rollup.
object
The average value of the metric.
The total sum value of the metric.
The latest information.
object
The date (ISO 8601).
The value.
A metric rollup.
object
The average value of the metric.
The total sum value of the metric.
The latest information.
object
The date (ISO 8601).
The value.
A metric rollup.
object
The average value of the metric.
The total sum value of the metric.
The latest information.
object
The date (ISO 8601).
The value.
Examplegenerated
{ "visit_count": { "average": "example", "sum": "example", "latest": { "date": "example", "value": "example" } }, "network_origin_bytes": { "average": "example", "sum": "example", "latest": { "date": "example", "value": "example" } }, "storage_file_bytes": { "average": "example", "sum": "example", "latest": { "date": "example", "value": "example" } }, "storage_database_bytes": { "average": "example", "sum": "example", "latest": { "date": "example", "value": "example" } }, "billable_visits": { "average": "example", "sum": "example", "latest": { "date": "example", "value": "example" } }, "request_origin_count": { "average": "example", "sum": "example", "latest": { "date": "example", "value": "example" } }, "network_cdn_bytes": { "average": "example", "sum": "example", "latest": { "date": "example", "value": "example" } }, "network_total_bytes": { "average": "example", "sum": "example", "latest": { "date": "example", "value": "example" } }}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
An invalid response was received from an upstream server
Service unavailable