Menu
Amazon CloudWatch
API Reference (API Version 2010-08-01)

GetMetricData

You can use the GetMetricData API to retrieve as many as 100 different metrics in a single request, with a total of as many as 100,800 datapoints. You can also optionally perform math expressions on the values of the returned statistics, to create new time series that represent new insights into your data. For example, using Lambda metrics, you could divide the Errors metric by the Invocations metric to get an error rate time series. For more information about metric math expressions, see Metric Math Syntax and Functions in the Amazon CloudWatch User Guide.

Calls to the GetMetricData API have a different pricing structure than calls to GetMetricStatistics. For more information about pricing, see Amazon CloudWatch Pricing.

Amazon CloudWatch retains metric data as follows:

  • Data points with a period of less than 60 seconds are available for 3 hours. These data points are high-resolution metrics and are available only for custom metrics that have been defined with a StorageResolution of 1.

  • Data points with a period of 60 seconds (1-minute) are available for 15 days.

  • Data points with a period of 300 seconds (5-minute) are available for 63 days.

  • Data points with a period of 3600 seconds (1 hour) are available for 455 days (15 months).

Data points that are initially published with a shorter period are aggregated together for long-term storage. For example, if you collect data using a period of 1 minute, the data remains available for 15 days with 1-minute resolution. After 15 days, this data is still available, but is aggregated and retrievable only with a resolution of 5 minutes. After 63 days, the data is further aggregated and is available with a resolution of 1 hour.

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

EndTime

The time stamp indicating the latest data to be returned.

For better performance, specify StartTime and EndTime values that align with the value of the metric's Period and sync up with the beginning and end of an hour. For example, if the Period of a metric is 5 minutes, specifying 12:05 or 12:30 as EndTime can get a faster response from CloudWatch then setting 12:07 or 12:29 as the EndTime.

Type: Timestamp

Required: Yes

MaxDatapoints

The maximum number of data points the request should return before paginating. If you omit this, the default of 100,800 is used.

Type: Integer

Required: No

MetricDataQueries.member.N

The metric queries to be returned. A single GetMetricData call can include as many as 100 MetricDataQuery structures. Each of these structures can specify either a metric to retrieve, or a math expression to perform on retrieved data.

Type: Array of MetricDataQuery objects

Required: Yes

NextToken

Include this value, if it was returned by the previous call, to get the next set of data points.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 1024.

Required: No

ScanBy

The order in which data points should be returned. TimestampDescending returns the newest data first and paginates when the MaxDatapoints limit is reached. TimestampAscending returns the oldest data first and paginates when the MaxDatapoints limit is reached.

Type: String

Valid Values: TimestampDescending | TimestampAscending

Required: No

StartTime

The time stamp indicating the earliest data to be returned.

For better performance, specify StartTime and EndTime values that align with the value of the metric's Period and sync up with the beginning and end of an hour. For example, if the Period of a metric is 5 minutes, specifying 12:05 or 12:30 as StartTime can get a faster response from CloudWatch then setting 12:07 or 12:29 as the StartTime.

Type: Timestamp

Required: Yes

Response Elements

The following elements are returned by the service.

MetricDataResults.member.N

The metrics that are returned, including the metric name, namespace, and dimensions.

Type: Array of MetricDataResult objects

NextToken

A token that marks the next batch of returned results.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 1024.

Errors

For information about the errors that are common to all actions, see Common Errors.

InvalidNextToken

The next token specified is invalid.

HTTP Status Code: 400

Examples

Example

The following example requests three separate metrics across two namespaces.

Sample Request

{ "StartTime": 1518867432, "EndTime": 1518867832, "MetricDataQueries": [ { "Id": "m1", "MetricStat": { "Metric": { "Namespace": "AWS/EC2", "MetricName": "NetworkOut", "Dimensions": [ { "Name": "AutoScalingGroupName", "Value": "my-asg-A" } ] }, "Period": 300, "Stat": "Average", "Unit": "Gigabytes" } }, { "Id": "m2", "MetricStat": { "Metric": { "Namespace": "AWS/EC2", "MetricName": "NetworkOut", "Dimensions": [ { "Name": "AutoScalingGroupName", "Value": "my-asg-A" } ] }, "Period": 300, "Stat": "SampleCount", "Unit": "Count" } }, { "Id": "m3", "MetricStat": { "Metric": { "Namespace": "AWS/ELB", "MetricName": "HealthyHostCount", "Dimensions": [ { "Name": "LoadBalancerName", "Value": "my-lb-B" } ] }, "Period": 300, "Stat": "Sum", "Unit": "None" } } ] }

Sample Response

{ "MetricDataResults": [ { "Id": "m1", "StatusCode": "Complete", "Label": "AWS/EC2 NetworkOut Average", "Timestamps": [ 1518867432, 1518867732, 1518868032 ], "Values": [ 15000, 14000, 16000 ] }, { "Id": "m2", "StatusCode": "Complete", "Label": "AWS/EC2 NetworkOut SampleCount", "Timestamps": [ 1518867432, 1518867732, 1518868032 ], "Values": [ 15, 14, 16 ] }, { "Id": "m3", "StatusCode": "Complete", "Label": "AWS/EC2 HealthyHostCount", "Timestamps": [ 1518867432, 1518867732, 1518868032 ], "Values": [ 15, 14, 16 ] } ] }

Example

The following example retrieves the NetworkOut metric for two Auto Scaling groups, and uses them in an expression. These two metrics are called m1 and m2, and the expression calculates e1 as the results of m2/m1. The raw values and time stamps of the NetworkOut metrics are not returned.

Sample Request

{ "StartTime": 1518867432, "EndTime": 1518867832, "MetricQueries": [ { "Id": "e1", "Expression": "m2 / m1", "Label": "my-asg-B / my-asg-A" }, { "Id": "m1", "MetricStat": { "Metric": { "Namespace": "AWS/EC2", "MetricName": "NetworkOut", "Dimensions": [ { "Name": "AutoScalingGroupName", "Value": "my-asg-A" } ] }, "Period": 300, "Stat": "SampleCount", "Unit": "Gigabytes" }, "ReturnData": false }, { "Id": "m2", "MetricStat": { "Metric": { "Namespace": "AWS/EC2", "MetricName": "NetworkOut", "Dimensions": [ { "Name": "AutoScalingGroupName", "Value": "my-asg-B" } ] }, "Period": 300, "Stat": "SampleCount", "Unit": "Gigabytes" }, "ReturnData": false } ] }

Sample Response

{ "MetricDataResults": [ { "Id": "m1", "StatusCode": "Complete" }, { "Id": "m2", "StatusCode": "Complete" }, { "Id": "e1", "StatusCode": "Complete", "Label": "my-asg-B / my-asg-A", "Timestamps": [ 1518867432, 1518867732, 1518868032 ], "Values": [ 100, 100, 100 ] } ] }

Example

In the following example, two levels of expressions are used, with the result of one expression used as an input to the next expression:

Sample Request

{ "StartTime": 1518867432, "EndTime": 1518867832, "MetricDataQueries": [ { "Id": "e1", "Expression": "e2 + m3", "Label": "my-asg-A * my-asg-B + my-asg-C" }, { "Id": "e2", "Expression": "m1 * m2", "Label": "my-asg-A * my-asg-B" }, { "Id": "m1", "MetricStat": { "Metric": { "Namespace": "AWS/EC2", "MetricName": "NetworkOut", "Dimensions": [ { "Name": "AutoScalingGroupName", "Value": "my-asg-A" } ] }, "Period": 300, "Stat": "SampleCount", "Unit": "Gigabytes" }, "ReturnData": false }, { "Id": "m2", "MetricStat": { "Metric": { "Namespace": "AWS/EC2", "MetricName": "NetworkOut", "Dimensions": [ { "Name": "AutoScalingGroupName", "Value": "my-asg-B" } ] }, "Period": 300, "Stat": "SampleCount", "Unit": "Gigabytes" }, "ReturnData": false }, { "Id": "m3", "MetricStat": { "Metric": { "Namespace": "AWS/EC2", "MetricName": "NetworkOut", "Dimensions": [ { "Name": "AutoScalingGroupName", "Value": "my-asg-C" } ] }, "Period": 300, "Stat": "SampleCount", "Unit": "Gigabytes" }, "ReturnData": false } ] }

Sample Response

{ "MetricDataResults": [ { "Id": "m1", "StatusCode": "Complete" }, { "Id": "m2", "StatusCode": "Complete" }, { "Id": "m3", "StatusCode": "Complete" }, { "Id": "e1", "StatusCode": "Complete", "Label": "my-asg-A * my-asg-B + my-asg-C", "Timestamps": [ 1518867432, 1518867732, 1518868032 ], "Values": [ 200, 200, 200 ] }, { "Id": "e2", "StatusCode": "Complete", "Label": "my-asg-A * my-asg-B", "Timestamps": [ 1518867432, 1518867732, 1518868032 ], "Values": [ 100, 100, 100 ] } ] }

Example

In the following example, custom metrics are searched and assigned IDs that contain either "error" or "request", even if the original metric names did not contain those words. Then an error rate is calculated using the METRICS("string") function on the assigned IDs.

Sample Request

{ "StartTime": 1518867432, "EndTime": 1518867832, "MetricDataQueries": [ { "Id": "errorRate", "Label": "Error Rate", "Expression": "errors/requests" }, { "Id": "errorRatePercent", "Label": "% Error Rate", "Expression": "errorRate*100" }, { "Id": "requests", "Expression": "SUM(METRICS('request'))", "ReturnData": false }, { "Id": "errors", "Expression": "SUM(METRICS('error'))", "ReturnData": false }, { "Id": "error1", "MetricStat": { "Metric": { "Namespace": "MyService", "MetricName": "BadRequests", "Dimensions": [ { "Name": "Component", "Value": "component-1" } ] }, "Period": 60, "Stat": "Sum" }, "ReturnData": false }, { "Id": "error2", "MetricStat": { "Metric": { "Namespace": "MyService", "MetricName": "ConnectionErrors", "Dimensions": [ { "Name": "Component", "Value": "component-1" } ] }, "Period": 60, "Stat": "Sum" }, "ReturnData": false }, { "Id": "request1", "MetricStat": { "Metric": { "Namespace": "MyService", "MetricName": "InternalRequests", "Dimensions": [ { "Name": "Component", "Value": "component-1" } ] }, "Period": 60, "Stat": "Sum" }, "ReturnData": false }, { "Id": "request2", "MetricStat": { "Metric": { "Namespace": "MyService", "MetricName": "ExternalRequests", "Dimensions": [ { "Name": "Component", "Value": "component-1" } ] }, "Period": 60, "Stat": "Sum" }, "ReturnData": false } ] }

Sample Response

{ "MetricDataResults": [ { "Id": "errorRate", "Label": "Error Rate", "StatusCode": "Complete", "Timestamps": [ 1518867432, 1518867732, 1518868032 ], "Values": [ 0.1, 0.5, 0.3 ] }, { "Id": "errorRatePercent", "Label": "% Error Rate", "StatusCode": "Complete", "Timestamps": [ 1518867432, 1518867732, 1518868032 ], "Values": [ 10, 50, 30 ] } ] }

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: