Gets the resource consumption details for whatever window specified in the request. Data can be retrieve for a variety of time windows and intervals. Calls to this operation must include a token acquired from the authentication endpoint. See the Login API for information on acquiring this token.
When to Use It
Use this API operation when you want to track the resource usage of servers within a group hierarchy. It can be used to populate a local data mart or chart the results on a dashboard.
URL
Structure
GET https://api.ctl.io/v2/groups/{accountAlias}/{groupId}/statistics?type=hourly&start={datetime}&end={datetime}&sampleInterval={dd:hh:mm:ss}
Example
GET https://api.ctl.io/v2/groups/ALIAS/2a5c0b9662cf4fc8bf6180f139facdc0/statistics?type=hourly&start=2014-04-05T07:52:47.302Z&end=2014-04-07T07:52:47.302Z&sampleInterval=01:00:00
Request
URI and Querystring Parameters
Name
Type
Description
Req.
AccountAlias
string
Short code for a particular account
Yes
GroupID
string
ID of the group being queried. Retrieved from query to parent group, or by looking at the URL on the new UI pages in the Control Portal.
Yes
type
string
Valid values are latest, hourly, or realtime.
latest will return a single data point that reflects the last monitoring data collected. No start, end, or sampleInterval values are required for this type.
hourly returns data points for each sampleInterval value between the start and end times provided. The start and sampleInterval parameters are both required for this type.
realtime will return data from the last 4 hours, available in smaller increments. To use realtime type, start parameter must be within the last 4 hours. The start and sampleInterval parameters are both required for this type.
Yes
start
datetime
DateTime (UTC) of the query window. Note that statistics are only held for 14 days. Start date (and optional end date) must be within the past 14 days. Value is not required if choosing the latest query type.
Yes, except for latest type
end
datetime
DateTime (UTC) of the query window. Default is the current time in UTC. End date (and start date) must be within the past 14 days. Not a required value if results should be up to the current time.
No
sampleInterval
timespan
Result interval. For the default hourly type, the minimum value is 1 hour (01:00:00) and maximum is the full window size of 14 days. Note that interval must fit within start/end window, or you will get an exception that states: "The 'end' parameter must represent a time that occurs at least one 'sampleInterval' before 'start.'" If realtime type is specified, interval can be as small as 5 minutes (05:00).
Yes, except for latest type
Response
Entity Definition
Name
Type
Description
name
string
Name of the server
stats
array
Collection of stats for the server for the interval chosen
Stats Definition
Name
Type
Description
timestamp
datetime
Timestamp of the monitoring results
cpu
float
CPU allocation during the interval
cpuPercent
float
CPU consumption (out of 100%) during the interval
memoryMB
float
Memory allocation during the interval
memoryPercent
float
Memory consumption (out of 100%) during the interval
networkReceivedKbps
float
Public network consumption in during the interval
networkTransmittedKbps
float
Public network consumption out during the interval
diskUsageTotalCapacityMB
float
Total disk allocation during the interval
diskUsage
array
List of physical disks attached to the virtual machine
