Get account usage insights

GET

/accounts/{account_id}/usage/insights

package main

import (
  "fmt"
  "net/http"
  "io"
)

func main() {

  url := "https://api.wpengineapi.com/v1/accounts/example/usage/insights"

  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/example/usage/insights';
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/example/usage/insights \
  --header 'Authorization: Basic <credentials>'

Get detailed usage insights for the specified account across different environment types and site types. The default response is a summary of the last 30 days. The optional first_date and last_date arguments can be specified to retrieve insights over a custom date range. Both arguments must be provided and the range cannot exceed 31 days.

Authorizations

basicAuth

Parameters

Path Parameters

account_id

required

string format: uuid

ID of account

Query Parameters

first_date

string format: date

/^\d{4}-\d{2}-\d{2}$/

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.

last_date

string format: date

/^\d{4}-\d{2}-\d{2}$/

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

200

Success

application/json

Comprehensive account usage insights broken down by environment types and site types

object

visit_count

Usage metric with breakdown by environment and site types

object

total

The total usage value

string

environment_types

Breakdown of usage by environment type

object

production

Usage for production environments

string

staging

Usage for staging environments

string

development

Usage for development environments

string

site_types

Breakdown of usage by site type

object

standard

Usage for standard sites

string

transferable

Usage for transferable sites

string

sandbox

Usage for sandbox sites

string

billable_visits

Usage metric with breakdown by environment and site types

object

total

The total usage value

string

environment_types

Breakdown of usage by environment type

object

production

Usage for production environments

string

staging

Usage for staging environments

string

development

Usage for development environments

string

site_types

Breakdown of usage by site type

object

standard

Usage for standard sites

string

transferable

Usage for transferable sites

string

sandbox

Usage for sandbox sites

string

network_origin_bytes

Usage metric with breakdown by environment and site types

object

total

The total usage value

string

environment_types

Breakdown of usage by environment type

object

production

Usage for production environments

string

staging

Usage for staging environments

string

development

Usage for development environments

string

site_types

Breakdown of usage by site type

object

standard

Usage for standard sites

string

transferable

Usage for transferable sites

string

sandbox

Usage for sandbox sites

string

network_cdn_bytes

Usage metric with breakdown by environment and site types

object

total

The total usage value

string

environment_types

Breakdown of usage by environment type

object

production

Usage for production environments

string

staging

Usage for staging environments

string

development

Usage for development environments

string

site_types

Breakdown of usage by site type

object

standard

Usage for standard sites

string

transferable

Usage for transferable sites

string

sandbox

Usage for sandbox sites

string

network_total_bytes

Usage metric with breakdown by environment and site types

object

total

The total usage value

string

environment_types

Breakdown of usage by environment type

object

production

Usage for production environments

string

staging

Usage for staging environments

string

development

Usage for development environments

string

site_types

Breakdown of usage by site type

object

standard

Usage for standard sites

string

transferable

Usage for transferable sites

string

sandbox

Usage for sandbox sites

string

storage_file_bytes

Usage metric with breakdown by environment and site types

object

total

The total usage value

string

environment_types

Breakdown of usage by environment type

object

production

Usage for production environments

string

staging

Usage for staging environments

string

development

Usage for development environments

string

site_types

Breakdown of usage by site type

object

standard

Usage for standard sites

string

transferable

Usage for transferable sites

string

sandbox

Usage for sandbox sites

string

storage_database_bytes

Usage metric with breakdown by environment and site types

object

total

The total usage value

string

environment_types

Breakdown of usage by environment type

object

production

Usage for production environments

string

staging

Usage for staging environments

string

development

Usage for development environments

string

site_types

Breakdown of usage by site type

object

standard

Usage for standard sites

string

transferable

Usage for transferable sites

string

sandbox

Usage for sandbox sites

string

request_origin_count

Usage metric with breakdown by environment and site types

object

total

The total usage value

string

environment_types

Breakdown of usage by environment type

object

production

Usage for production environments

string

staging

Usage for staging environments

string

development

Usage for development environments

string

site_types

Breakdown of usage by site type

object

standard

Usage for standard sites

string

transferable

Usage for transferable sites

string

sandbox

Usage for sandbox sites

string

Example

{
  "visit_count": {
    "total": "1695",
    "environment_types": {
      "production": "1354",
      "staging": "177",
      "development": "164"
    },
    "site_types": {
      "standard": "1683",
      "transferable": "7",
      "sandbox": "5"
    }
  },
  "billable_visits": {
    "total": "1695",
    "environment_types": {
      "production": "1354",
      "staging": "177",
      "development": "164"
    },
    "site_types": {
      "standard": "1683",
      "transferable": "7",
      "sandbox": "5"
    }
  },
  "network_origin_bytes": {
    "total": "1695",
    "environment_types": {
      "production": "1354",
      "staging": "177",
      "development": "164"
    },
    "site_types": {
      "standard": "1683",
      "transferable": "7",
      "sandbox": "5"
    }
  },
  "network_cdn_bytes": {
    "total": "1695",
    "environment_types": {
      "production": "1354",
      "staging": "177",
      "development": "164"
    },
    "site_types": {
      "standard": "1683",
      "transferable": "7",
      "sandbox": "5"
    }
  },
  "network_total_bytes": {
    "total": "1695",
    "environment_types": {
      "production": "1354",
      "staging": "177",
      "development": "164"
    },
    "site_types": {
      "standard": "1683",
      "transferable": "7",
      "sandbox": "5"
    }
  },
  "storage_file_bytes": {
    "total": "1695",
    "environment_types": {
      "production": "1354",
      "staging": "177",
      "development": "164"
    },
    "site_types": {
      "standard": "1683",
      "transferable": "7",
      "sandbox": "5"
    }
  },
  "storage_database_bytes": {
    "total": "1695",
    "environment_types": {
      "production": "1354",
      "staging": "177",
      "development": "164"
    },
    "site_types": {
      "standard": "1683",
      "transferable": "7",
      "sandbox": "5"
    }
  },
  "request_origin_count": {
    "total": "1695",
    "environment_types": {
      "production": "1354",
      "staging": "177",
      "development": "164"
    },
    "site_types": {
      "standard": "1683",
      "transferable": "7",
      "sandbox": "5"
    }
  }
}

400

Bad Request

application/json

object

message

required

A message regarding the error that occurred on the server

string

documentation_url

(Optional) A URL where documentation regarding this specific error can be found

string

errors

An array of error objects describing specific errors that arose when servicing the request

Array<object>

object

resource

required

The name of the resource that was being processed when the error occurred

string

field

required

(Optional) The specific field associated with the error

string

type

required

(Optional) A type associated with the error. invalid_value, access_error, value_unavailable

string

code

required

(Optional) A machine code relating to the error that occurred with the field and resource

string

message

required

(Optional) A human-readable message relating to the error that occurred with the field and resource

string

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)"
    }
  ]
}

401

Authentication Error

application/json

object

message

required

A message regarding the error that occurred on the server

string

documentation_url

(Optional) A URL where documentation regarding this specific error can be found

string

Example

{
  "message": "Bad Credentials"
}

403

Not authorized

application/json

object

message

required

A message regarding the error that occurred on the server

string

documentation_url

(Optional) A URL where documentation regarding this specific error can be found

string

Example

{
  "message": "You don't have permission to perform that action"
}

404

Not found

application/json

object

message

required

A message regarding the error that occurred on the server

string

documentation_url

(Optional) A URL where documentation regarding this specific error can be found

string

Example

{
  "message": "Not Found"
}

429

Too many requests

application/json

502

An invalid response was received from an upstream server

application/json

503

Service unavailable

application/json

Platforms

Product Extensions

Plugins

Tools

Get account usage insights

Authorizations

Parameters

Path Parameters

Query Parameters

Responses

200

Example

400

Example

401

Example

403

Example

404

Example

429

502

503