Menu
Amazon CloudWatch
User Guide

Amazon API Gateway Metrics and Dimensions

The metrics and dimensions that API Gateway sends to Amazon CloudWatch are listed below. For more information, see Monitor API Execution with Amazon CloudWatch in the Amazon API Gateway Developer Guide.

API Gateway Metrics

Amazon API Gateway sends metric data to CloudWatch every minute.

The AWS/ApiGateway namespace includes the following metrics.

MetricDescription

4XXError

The number of client-side errors captured

Unit: count

5XXError

The number of server-side errors captured.

Unit: count

CacheHitCount

The number of requests served from the API cache.

Unit: count

CacheMissCount

The number of requests served from the back end when API caching is enabled.

Unit: count

Count

The number of calls to API methods.

Unit: count

IntegrationLatency

The time between when API Gateway relays a request to the back end and when it receives a response from the back end.

Unit: millisecond

Latency

The time between when API Gateway receives a request from a client and when it returns a response to the client.

Unit: millisecond

Dimensions for Metrics

You can use the dimensions in the following table to filter API Gateway metrics.

DimensionDescription

ApiName

Filters API Gateway metrics for an API of the specified API name.

ApiName, Method, Resource, Stage

Filters API Gateway metrics for an API method of the specified API, stage, resource, and method.

API Gateway will not send such metrics unless you have explicitly enabled detailed CloudWatch metrics. You can do this in the console by selecting Enable CloudWatch Metrics under a stage Settings tab. Alternatively, you can call the stage:update action of the API Gateway REST API to update the metricsEnabled property to true.

Enabling such metrics will incur additional charges to your account. For pricing information, see Amazon CloudWatch Pricing.

ApiName, Stage

Filters API Gateway metrics for an API stage of the specified API and stage.