Get account usage insights
GET /accounts/{account_id}/usage/insights
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
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
Comprehensive account usage insights broken down by environment types and site types
object
Usage metric with breakdown by environment and site types
object
The total usage value
Example
1695Breakdown of usage by environment type
object
Usage for production environments
Example
1354Usage for staging environments
Example
177Usage for development environments
Example
164Breakdown of usage by site type
object
Usage for standard sites
Example
1683Usage for transferable sites
Example
7Usage for sandbox sites
Example
5Usage metric with breakdown by environment and site types
object
The total usage value
Example
1695Breakdown of usage by environment type
object
Usage for production environments
Example
1354Usage for staging environments
Example
177Usage for development environments
Example
164Breakdown of usage by site type
object
Usage for standard sites
Example
1683Usage for transferable sites
Example
7Usage for sandbox sites
Example
5Usage metric with breakdown by environment and site types
object
The total usage value
Example
1695Breakdown of usage by environment type
object
Usage for production environments
Example
1354Usage for staging environments
Example
177Usage for development environments
Example
164Breakdown of usage by site type
object
Usage for standard sites
Example
1683Usage for transferable sites
Example
7Usage for sandbox sites
Example
5Usage metric with breakdown by environment and site types
object
The total usage value
Example
1695Breakdown of usage by environment type
object
Usage for production environments
Example
1354Usage for staging environments
Example
177Usage for development environments
Example
164Breakdown of usage by site type
object
Usage for standard sites
Example
1683Usage for transferable sites
Example
7Usage for sandbox sites
Example
5Usage metric with breakdown by environment and site types
object
The total usage value
Example
1695Breakdown of usage by environment type
object
Usage for production environments
Example
1354Usage for staging environments
Example
177Usage for development environments
Example
164Breakdown of usage by site type
object
Usage for standard sites
Example
1683Usage for transferable sites
Example
7Usage for sandbox sites
Example
5Usage metric with breakdown by environment and site types
object
The total usage value
Example
1695Breakdown of usage by environment type
object
Usage for production environments
Example
1354Usage for staging environments
Example
177Usage for development environments
Example
164Breakdown of usage by site type
object
Usage for standard sites
Example
1683Usage for transferable sites
Example
7Usage for sandbox sites
Example
5Usage metric with breakdown by environment and site types
object
The total usage value
Example
1695Breakdown of usage by environment type
object
Usage for production environments
Example
1354Usage for staging environments
Example
177Usage for development environments
Example
164Breakdown of usage by site type
object
Usage for standard sites
Example
1683Usage for transferable sites
Example
7Usage for sandbox sites
Example
5Usage metric with breakdown by environment and site types
object
The total usage value
Example
1695Breakdown of usage by environment type
object
Usage for production environments
Example
1354Usage for staging environments
Example
177Usage for development environments
Example
164Breakdown of usage by site type
object
Usage for standard sites
Example
1683Usage for transferable sites
Example
7Usage for sandbox sites
Example
5Bad 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