Amazon API Gateway dimensions and metrics
The metrics and dimensions that API Gateway sends to Amazon CloudWatch are listed below. For more information, see Monitoring REST API execution with Amazon CloudWatch metrics.
API Gateway metrics
Amazon API Gateway sends metric data to CloudWatch every minute.
The AWS/ApiGateway
namespace includes the following metrics.
Metric | Description |
---|---|
4XXError |
The number of client-side errors captured in a given period. The Unit: Count |
5XXError |
The number of server-side errors captured in a given period. The Unit: Count |
CacheHitCount |
The number of requests served from the API cache in a given period. The Unit: Count |
CacheMissCount |
The number of requests served from the backend in a given period, when API caching is enabled. The Unit: Count |
Count |
The total number API requests in a given period. The Unit: Count |
IntegrationLatency |
The time between when API Gateway relays a request to the backend and when it receives a response from the backend. Unit: Millisecond |
Latency |
The time between when API Gateway receives a request from a client and when it returns a response to the client. The latency includes the integration latency and other API Gateway overhead. Unit: Millisecond |
Dimensions for metrics
You can use the dimensions in the following table to filter API Gateway metrics.
API Gateway removes non-ASCII characters from the ApiName dimension before sending metrics to CloudWatch. If the APIName contains no ASCII characters, the API ID is used as the ApiName.
Dimension | Description |
---|---|
ApiName |
Filters API Gateway metrics for the REST API with the specified API name. |
ApiName, Method, Resource, Stage |
Filters API Gateway metrics for the API method with the specified API name, stage, resource, and method. API Gateway will not send these 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 update-stage AWS CLI command to update the
Enabling these metrics will incur additional charges to your
account. For pricing information, see Amazon CloudWatch
Pricing |
ApiName, Stage |
Filters API Gateway metrics for the API stage resource with the specified API name and stage. |