Skip to content
WP Engine |Hosting Platform API

Get a list of daily usage metrics

GET
/installs/{install_id}/usage

Get a list of daily usage metrics related to this install. If the optional first_date and last_date arguments are omitted, the response will include metrics for the last 60 days. For days where there are no storage metrics, they will be artificially filled with the last known storage metrics.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
install_id
required
string format: uuid

The UUID of the install.

Query Parameters

Section titled “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

Section titled “ Responses ”

200

Section titled “200 ”

A successful response.

A daily usage metrics series.

object
install_name

The name of the install for the included metrics.

string
metrics

The requested metrics for an install. Metrics will include daily usage metrics for the last 30 days. Metrics will be sorted in descending order (most recent date first).

Array<object>

Usage metrics collected over the period of one day.

In JSON format, the DailyUsageMetrics int64 values are encoded as a string rather than a number, following the proto3 specification.

object
date

The date (ISO 8601).

string
visit_count

Total visits.

string format: int64
network_origin_bytes

Data served over HTTP by the origin server.

This does not include cached data served from a CDN.

string format: int64
storage_file_bytes

Storage used by this environment’s files.

This includes all files in the web root directory.

string format: int64
storage_database_bytes

Storage used by this environment’s database.

string format: int64
billable_visits

Billable visits.

string format: int64
request_origin_count

The total number of HTTP requests received by the origin server.

This does not include cached requests that were served from a CDN.

string format: int64
network_cdn_bytes

The data served by the CDN.

string format: int64
storage_update_time

The most recent storage usage measurement time (in UTC).

string format: date-time
network_total_bytes

The sum of CDN and origin network bytes.

string format: int64
traffic_metrics_source

The source of the traffic metrics.

string
default: TRAFFIC_METRICS_SOURCE_UNSPECIFIED
Allowed values: TRAFFIC_METRICS_SOURCE_UNSPECIFIED ONHOST BIGQUERY
database_tables_count

The number of tables in the install’s database.

string format: int64
database_sql_bytes

The sum of bytes of the database content in MySQL for an install.

string format: int64
autoloaded_bytes

The sum of bytes that is automatically loaded on each request to the install.

string format: int64
largest_files

The largest files in the install in bytes, received as a tab-separated list of file paths and sizes.

Array<string>
metrics_rollup

Rollup of the usage metrics.

object
visit_count

A rollup of total visits.

The average field represents the average total visits per day on all installs. The sum field represents the sum of all the total visits on all installs. The latest field is not applicable to the total visits and will be empty.

object
average

The average value of the metric.

string format: int64
sum

The total sum value of the metric.

string format: int64
latest

The latest value of the metric.

object
date

The date (ISO 8601).

string
value

The value.

string format: int64
network_origin_bytes

A Rollup of data transfer metrics.

The average field represents the average data transfer metrics per day on all installs. The sum field represents the sum of all the data transfer metrics on all installs. The latest field is not applicable to the data transfer metrics and will be empty.

object
average

The average value of the metric.

string format: int64
sum

The total sum value of the metric.

string format: int64
latest

The latest value of the metric.

object
date

The date (ISO 8601).

string
value

The value.

string format: int64
storage_file_bytes

A rollup of file storage metrics.

The latest field represents the sum of all the latest metrics for file storage on all installs. The average and sum fields will be empty.

object
average

The average value of the metric.

string format: int64
sum

The total sum value of the metric.

string format: int64
latest

The latest value of the metric.

object
date

The date (ISO 8601).

string
value

The value.

string format: int64
storage_database_bytes

A rollup of database storage metrics.

The latest field represents the sum of all the latest metrics for database storage on all installs. The average and sum fields will be empty.

object
average

The average value of the metric.

string format: int64
sum

The total sum value of the metric.

string format: int64
latest

The latest value of the metric.

object
date

The date (ISO 8601).

string
value

The value.

string format: int64
billable_visits

A rollup of billable visits.

The average field represents the average billable visits per day on all installs. The sum field represents the sum of all the billable visits on all installs. The latest field is not applicable to the billable visits and will be empty.

object
average

The average value of the metric.

string format: int64
sum

The total sum value of the metric.

string format: int64
latest

The latest value of the metric.

object
date

The date (ISO 8601).

string
value

The value.

string format: int64
request_origin_count

A rollup of total number of requests.

The average field represents the average requests per day on all installs. The sum field represents the sum of all requests on all installs. The latest field is not applicable to the requests and will be empty.

object
average

The average value of the metric.

string format: int64
sum

The total sum value of the metric.

string format: int64
latest

The latest value of the metric.

object
date

The date (ISO 8601).

string
value

The value.

string format: int64
network_cdn_bytes

A rollup of total number of bytes served by CDN.

The average field represents the average bytes per day on all installs. The sum field represents the sum of all bytes on all installs. The latest field is not applicable to the bytes and will be empty.

object
average

The average value of the metric.

string format: int64
sum

The total sum value of the metric.

string format: int64
latest

The latest value of the metric.

object
date

The date (ISO 8601).

string
value

The value.

string format: int64
network_total_bytes

A rollup of total number of bytes served by CDN and origin.

The average field represents the average bytes per day on all installs. The sum field represents the sum of all network bytes on all installs. The latest field is not applicable to the bytes and will be empty.

object
average

The average value of the metric.

string format: int64
sum

The total sum value of the metric.

string format: int64
latest

The latest value of the metric.

object
date

The date (ISO 8601).

string
value

The value.

string format: int64
storage_refresh_expected_time

Represents the estimated completion time (in UTC) for a refresh disk usage operation. If a refresh is not in progress, then this field will be null.

string format: date-time

400

Section titled “400 ”

Bad Request. The request was improperly formatted or contained invalid parameters.

object
message
required

A message explaining the error.

string
Example
Must provide or omit both first_date and last_date.

404

Section titled “404 ”

Not Found. The requested install id does not exist.

object
message
required

A message regarding the error that occurred on the server

string
Example
Not Found
documentation_url

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

string

Examples

Section titled “Examples ”
{
  "message": "Not found"
}

default

Section titled “default ”

An unexpected error response.

object
message
required

A message regarding the error that occurred on the server

string
Example
An unexpected error occurred, please try again in a few minutes