Get account level usage summary
GET /accounts/{account_id}/usage/summary
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
Query 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 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
The average value of the metric.
The total sum value of the metric.
The latest value of the metric.
object
The date (ISO 8601).
The value.
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
The average value of the metric.
The total sum value of the metric.
The latest value of the metric.
object
The date (ISO 8601).
The value.
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
The average value of the metric.
The total sum value of the metric.
The latest value of the metric.
object
The date (ISO 8601).
The value.
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
The average value of the metric.
The total sum value of the metric.
The latest value of the metric.
object
The date (ISO 8601).
The value.
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
The average value of the metric.
The total sum value of the metric.
The latest value of the metric.
object
The date (ISO 8601).
The value.
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
The average value of the metric.
The total sum value of the metric.
The latest value of the metric.
object
The date (ISO 8601).
The value.
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
The average value of the metric.
The total sum value of the metric.
The latest value of the metric.
object
The date (ISO 8601).
The value.
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
The average value of the metric.
The total sum value of the metric.
The latest value of the metric.
object
The date (ISO 8601).
The value.
Bad Request
object
A message regarding the error that occurred on the server
Example
Invalid Site: Name cannot be empty.(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
Example
Site(Optional) The specific field associated with the error
Example
name(Optional) A type associated with the error. invalid_value, access_error, value_unavailable
Example
invalid_value(Optional) A machine code relating to the error that occurred with the field and resource
Example
too_long(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)Authentication Error
object
A message regarding the error that occurred on the server
Example
Bad Credentials(Optional) A URL where documentation regarding this specific error can be found
Not authorized
object
A message regarding the error that occurred on the server
Example
You don't have permission to perform that action(Optional) A URL where documentation regarding this specific error can be found
Not found
object
A message regarding the error that occurred on the server
Example
Not Found(Optional) A URL where documentation regarding this specific error can be found
Too many requests
An invalid response was received from an upstream server
Service unavailable