Grafana dashboard: AWS API Gateway
Description: Visualize AWS API Gateway metrics

## AWS API Gateway

Visualize AWS API Gateway metrics.

## CloudWatch datasource configuration

[https://grafana.com/docs/grafana/latest/datasources/cloudwatch/](https://grafana.com/docs/grafana/latest/datasources/cloudwatch/)

## Make Grafana AWS dashboards better

Feel free to add additional dashboards for other AWS resources (EC2, S3, ...) or update existing one in [GitHub repo](https://github.com/monitoringartist/grafana-aws-cloudwatch-dashboards).

## Commercial support for this dashboard

[![Monitoring Artist](https://monitoringartist.github.io/monitoring-artist-logo-grafana.png)](http://www.monitoringartist.com 'DevOps / Docker / Kubernetes / AWS ECS / Google GCP / Zabbix / Zenoss / Terraform / Monitoring')[![Monitoring Artist](https://monitoringartist.github.io/monitoring-artist-text-grafana.png)](http://www.monitoringartist.com 'DevOps / Docker / Kubernetes / AWS ECS / Google GCP / Zabbix / Zenoss / Terraform / Monitoring')

{
  "__inputs": [],
  "__requires": [
    {
      "type": "datasource",
      "id": "cloudwatch",
      "name": "CloudWatch",
      "version": "1.0.0"
    },
    {
      "type": "grafana",
      "id": "grafana",
      "name": "Grafana",
      "version": "7.1.5"
    },
    {
      "type": "panel",
      "id": "graph",
      "name": "Graph",
      "version": ""
    },
    {
      "type": "panel",
      "id": "text",
      "name": "Text",
      "version": "7.1.0"
    }
  ],
  "annotations": {
    "list": [
      {
        "builtIn": 1,
        "datasource": "-- Grafana --",
        "enable": true,
        "hide": true,
        "iconColor": "rgba(0, 211, 255, 1)",
        "name": "Annotations & Alerts",
        "type": "dashboard"
      }
    ]
  },
  "description": "Visualize AWS API Gateway metrics",
  "editable": false,
  "gnetId": 1516,
  "graphTooltip": 0,
  "id": null,
  "iteration": 1601391274139,
  "links": [],
  "panels": [
    {
      "aliasColors": {},
      "bars": false,
      "dashLength": 10,
      "dashes": false,
      "datasource": "$datasource",
      "editable": true,
      "error": false,
      "fieldConfig": {
        "defaults": {
          "custom": {},
          "links": []
        },
        "overrides": []
      },
      "fill": 1,
      "fillGradient": 0,
      "grid": {},
      "gridPos": {
        "h": 7,
        "w": 24,
        "x": 0,
        "y": 0
      },
      "hiddenSeries": false,
      "id": 7,
      "legend": {
        "alignAsTable": true,
        "avg": true,
        "current": true,
        "max": true,
        "min": true,
        "show": true,
        "sort": "current",
        "sortDesc": true,
        "total": true,
        "values": true
      },
      "lines": true,
      "linewidth": 2,
      "links": [],
      "nullPointMode": "null as zero",
      "percentage": false,
      "pluginVersion": "7.1.5",
      "pointradius": 5,
      "points": false,
      "renderer": "flot",
      "seriesOverrides": [
        {
          "alias": "Latency_Average",
          "yaxis": 2
        },
        {
          "alias": "TargetResponseTime_Average",
          "yaxis": 2
        },
        {
          "alias": "ClientConnections_Sum",
          "yaxis": 2
        }
      ],
      "spaceLength": 10,
      "stack": false,
      "steppedLine": false,
      "targets": [
        {
          "alias": "{{metric}} {{stat}}",
          "application": {
            "filter": ""
          },
          "dimensions": {
            "ApiName": "$apiname",
            "Stage": "$stage"
          },
          "expression": "",
          "functions": [],
          "group": {
            "filter": ""
          },
          "highResolution": false,
          "host": {
            "filter": ""
          },
          "id": "",
          "item": {
            "filter": ""
          },
          "matchExact": true,
          "metricName": "Count",
          "mode": 0,
          "namespace": "AWS/ApiGateway",
          "options": {
            "showDisabledItems": false
          },
          "period": "$agg",
          "refId": "A",
          "region": "$region",
          "statistics": [
            "Sum"
          ]
        }
      ],
      "thresholds": [],
      "timeFrom": null,
      "timeRegions": [],
      "timeShift": null,
      "title": "Count",
      "tooltip": {
        "msResolution": false,
        "shared": true,
        "sort": 0,
        "value_type": "cumulative"
      },
      "type": "graph",
      "xaxis": {
        "buckets": null,
        "mode": "time",
        "name": null,
        "show": true,
        "values": []
      },
      "yaxes": [
        {
          "$$hashKey": "object:124",
          "format": "none",
          "label": null,
          "logBase": 1,
          "max": null,
          "min": 0,
          "show": true
        },
        {
          "$$hashKey": "object:125",
          "format": "none",
          "label": null,
          "logBase": 1,
          "max": null,
          "min": 0,
          "show": false
        }
      ],
      "yaxis": {
        "align": false,
        "alignLevel": null
      }
    },
    {
      "aliasColors": {},
      "bars": false,
      "dashLength": 10,
      "dashes": false,
      "datasource": "$datasource",
      "editable": true,
      "error": false,
      "fieldConfig": {
        "defaults": {
          "custom": {},
          "links": []
        },
        "overrides": []
      },
      "fill": 1,
      "fillGradient": 0,
      "grid": {},
      "gridPos": {
        "h": 7,
        "w": 24,
        "x": 0,
        "y": 7
      },
      "hiddenSeries": false,
      "id": 14,
      "legend": {
        "alignAsTable": true,
        "avg": true,
        "current": true,
        "max": true,
        "min": true,
        "show": true,
        "sort": "current",
        "sortDesc": true,
        "total": false,
        "values": true
      },
      "lines": true,
      "linewidth": 2,
      "links": [],
      "nullPointMode": "null as zero",
      "percentage": false,
      "pluginVersion": "7.1.5",
      "pointradius": 5,
      "points": false,
      "renderer": "flot",
      "seriesOverrides": [
        {
          "alias": "Latency_Average",
          "yaxis": 1
        },
        {
          "alias": "TargetResponseTime_Average",
          "yaxis": 2
        },
        {
          "alias": "ClientConnections_Sum",
          "yaxis": 2
        },
        {
          "alias": "IntegrationLatency_Average",
          "yaxis": 2
        },
        {
          "alias": "IntegrationLatency",
          "yaxis": 2
        },
        {
          "alias": "IntegrationLatency Average",
          "yaxis": 1
        },
        {
          "alias": "Latency Maximum",
          "yaxis": 2
        }
      ],
      "spaceLength": 10,
      "stack": false,
      "steppedLine": false,
      "targets": [
        {
          "alias": "{{metric}} {{stat}}",
          "application": {
            "filter": ""
          },
          "dimensions": {
            "ApiName": "$apiname",
            "Stage": "$stage"
          },
          "expression": "",
          "functions": [],
          "group": {
            "filter": ""
          },
          "highResolution": false,
          "host": {
            "filter": ""
          },
          "id": "",
          "item": {
            "filter": ""
          },
          "metricName": "Latency",
          "mode": 0,
          "namespace": "AWS/ApiGateway",
          "options": {
            "showDisabledItems": false
          },
          "period": "$agg",
          "refId": "A",
          "region": "$region",
          "statistics": [
            "Average"
          ]
        },
        {
          "alias": "{{metric}} {{stat}}",
          "application": {
            "filter": ""
          },
          "dimensions": {
            "ApiName": "$apiname",
            "Stage": "$stage"
          },
          "expression": "",
          "functions": [],
          "group": {
            "filter": ""
          },
          "highResolution": false,
          "host": {
            "filter": ""
          },
          "id": "",
          "item": {
            "filter": ""
          },
          "metricName": "IntegrationLatency",
          "mode": 0,
          "namespace": "AWS/ApiGateway",
          "options": {
            "showDisabledItems": false
          },
          "period": "$agg",
          "refId": "B",
          "region": "$region",
          "statistics": [
            "Average"
          ]
        },
        {
          "alias": "{{metric}} {{stat}}",
          "application": {
            "filter": ""
          },
          "dimensions": {
            "ApiName": "$apiname",
            "Stage": "$stage"
          },
          "expression": "",
          "functions": [],
          "group": {
            "filter": ""
          },
          "highResolution": false,
          "host": {
            "filter": ""
          },
          "id": "",
          "item": {
            "filter": ""
          },
          "metricName": "Latency",
          "mode": 0,
          "namespace": "AWS/ApiGateway",
          "options": {
            "showDisabledItems": false
          },
          "period": "$agg",
          "refId": "C",
          "region": "$region",
          "statistics": [
            "Maximum"
          ]
        }
      ],
      "thresholds": [],
      "timeFrom": null,
      "timeRegions": [],
      "timeShift": null,
      "title": "Latency / IntegrationLatency",
      "tooltip": {
        "msResolution": false,
        "shared": true,
        "sort": 0,
        "value_type": "cumulative"
      },
      "type": "graph",
      "xaxis": {
        "buckets": null,
        "mode": "time",
        "name": null,
        "show": true,
        "values": []
      },
      "yaxes": [
        {
          "format": "ms",
          "label": null,
          "logBase": 1,
          "max": null,
          "min": 0,
          "show": true
        },
        {
          "format": "ms",
          "label": null,
          "logBase": 1,
          "max": null,
          "min": 0,
          "show": true
        }
      ],
      "yaxis": {
        "align": false,
        "alignLevel": null
      }
    },
    {
      "aliasColors": {
        "4XXError Sum": "#e24d42",
        "5XXError Sum": "#ef843c"
      },
      "bars": false,
      "dashLength": 10,
      "dashes": false,
      "datasource": "$datasource",
      "editable": true,
      "error": false,
      "fieldConfig": {
        "defaults": {
          "custom": {},
          "links": []
        },
        "overrides": []
      },
      "fill": 1,
      "fillGradient": 0,
      "grid": {},
      "gridPos": {
        "h": 7,
        "w": 24,
        "x": 0,
        "y": 14
      },
      "hiddenSeries": false,
      "id": 15,
      "legend": {
        "alignAsTable": true,
        "avg": true,
        "current": true,
        "max": true,
        "min": true,
        "show": true,
        "sort": "current",
        "sortDesc": true,
        "total": false,
        "values": true
      },
      "lines": true,
      "linewidth": 2,
      "links": [],
      "nullPointMode": "null as zero",
      "percentage": false,
      "pluginVersion": "7.1.5",
      "pointradius": 5,
      "points": false,
      "renderer": "flot",
      "seriesOverrides": [
        {
          "alias": "Total Error Rate",
          "yaxis": 2
        }
      ],
      "spaceLength": 10,
      "stack": false,
      "steppedLine": false,
      "targets": [
        {
          "alias": "{{metric}} {{stat}}",
          "application": {
            "filter": ""
          },
          "dimensions": {
            "ApiName": "$apiname",
            "Stage": "$stage"
          },
          "expression": "",
          "functions": [],
          "group": {
            "filter": ""
          },
          "highResolution": false,
          "host": {
            "filter": ""
          },
          "id": "e400",
          "item": {
            "filter": ""
          },
          "metricName": "4XXError",
          "mode": 0,
          "namespace": "AWS/ApiGateway",
          "options": {
            "showDisabledItems": false
          },
          "period": "",
          "refId": "A",
          "region": "$region",
          "statistics": [
            "Sum"
          ]
        },
        {
          "alias": "{{metric}} {{stat}}",
          "application": {
            "filter": ""
          },
          "dimensions": {
            "ApiName": "$apiname",
            "Stage": "$stage"
          },
          "expression": "",
          "functions": [],
          "group": {
            "filter": ""
          },
          "highResolution": false,
          "host": {
            "filter": ""
          },
          "id": "e500",
          "item": {
            "filter": ""
          },
          "metricName": "5XXError",
          "mode": 0,
          "namespace": "AWS/ApiGateway",
          "options": {
            "showDisabledItems": false
          },
          "period": "",
          "refId": "B",
          "region": "$region",
          "statistics": [
            "Sum"
          ]
        },
        {
          "alias": "{{metric}} {{stat}}",
          "application": {
            "filter": ""
          },
          "dimensions": {
            "ApiName": "$apiname",
            "Stage": "$stage"
          },
          "expression": "",
          "functions": [],
          "group": {
            "filter": ""
          },
          "hide": true,
          "highResolution": false,
          "host": {
            "filter": ""
          },
          "id": "countt",
          "item": {
            "filter": ""
          },
          "metricName": "Count",
          "mode": 0,
          "namespace": "AWS/ApiGateway",
          "options": {
            "showDisabledItems": false
          },
          "period": "",
          "refId": "E",
          "region": "$region",
          "statistics": [
            "Sum"
          ]
        },
        {
          "alias": "Total Error Rate",
          "application": {
            "filter": ""
          },
          "dimensions": {
            "ApiName": "$apiname",
            "Stage": "$stage"
          },
          "expression": "SUM([e400,e500])*100/countt",
          "functions": [],
          "group": {
            "filter": ""
          },
          "highResolution": false,
          "host": {
            "filter": ""
          },
          "id": "rate",
          "item": {
            "filter": ""
          },
          "metricName": "Count",
          "mode": 0,
          "namespace": "AWS/ApiGateway",
          "options": {
            "showDisabledItems": false
          },
          "period": "",
          "refId": "D",
          "region": "$region",
          "statistics": [
            "Sum"
          ]
        }
      ],
      "thresholds": [],
      "timeFrom": null,
      "timeRegions": [],
      "timeShift": null,
      "title": "4XXError / 5XXError",
      "tooltip": {
        "msResolution": false,
        "shared": true,
        "sort": 0,
        "value_type": "cumulative"
      },
      "type": "graph",
      "xaxis": {
        "buckets": null,
        "mode": "time",
        "name": null,
        "show": true,
        "values": []
      },
      "yaxes": [
        {
          "format": "none",
          "label": null,
          "logBase": 1,
          "max": null,
          "min": 0,
          "show": true
        },
        {
          "format": "percent",
          "label": null,
          "logBase": 1,
          "max": null,
          "min": 0,
          "show": true
        }
      ],
      "yaxis": {
        "align": false,
        "alignLevel": null
      }
    },
    {
      "aliasColors": {},
      "bars": false,
      "dashLength": 10,
      "dashes": false,
      "datasource": "$datasource",
      "editable": true,
      "error": false,
      "fieldConfig": {
        "defaults": {
          "custom": {},
          "links": []
        },
        "overrides": []
      },
      "fill": 1,
      "fillGradient": 0,
      "grid": {},
      "gridPos": {
        "h": 7,
        "w": 24,
        "x": 0,
        "y": 21
      },
      "hiddenSeries": false,
      "id": 16,
      "legend": {
        "alignAsTable": true,
        "avg": true,
        "current": true,
        "max": true,
        "min": true,
        "show": true,
        "sort": "current",
        "sortDesc": true,
        "total": false,
        "values": true
      },
      "lines": true,
      "linewidth": 2,
      "links": [],
      "nullPointMode": "null as zero",
      "percentage": false,
      "pluginVersion": "7.1.5",
      "pointradius": 5,
      "points": false,
      "renderer": "flot",
      "seriesOverrides": [
        {
          "alias": "Latency_Average",
          "yaxis": 1
        },
        {
          "alias": "TargetResponseTime_Average",
          "yaxis": 2
        },
        {
          "alias": "ClientConnections_Sum",
          "yaxis": 2
        },
        {
          "alias": "IntegrationLatency_Average",
          "yaxis": 2
        },
        {
          "alias": "5XXError_Average",
          "yaxis": 2
        },
        {
          "alias": "CacheHitCount Sum",
          "yaxis": 2
        }
      ],
      "spaceLength": 10,
      "stack": true,
      "steppedLine": false,
      "targets": [
        {
          "alias": "{{metric}} {{stat}}",
          "application": {
            "filter": ""
          },
          "dimensions": {
            "ApiName": "$apiname",
            "Stage": "$stage"
          },
          "expression": "",
          "functions": [],
          "group": {
            "filter": ""
          },
          "highResolution": false,
          "host": {
            "filter": ""
          },
          "id": "",
          "item": {
            "filter": ""
          },
          "matchExact": true,
          "metricName": "CacheHitCount",
          "mode": 0,
          "namespace": "AWS/ApiGateway",
          "options": {
            "showDisabledItems": false
          },
          "period": "$agg",
          "refId": "A",
          "region": "$region",
          "statistics": [
            "Sum"
          ]
        },
        {
          "alias": "{{metric}} {{stat}}",
          "application": {
            "filter": ""
          },
          "dimensions": {
            "ApiName": "$apiname",
            "Stage": "$stage"
          },
          "expression": "",
          "functions": [],
          "group": {
            "filter": ""
          },
          "highResolution": false,
          "host": {
            "filter": ""
          },
          "id": "",
          "item": {
            "filter": ""
          },
          "matchExact": true,
          "metricName": "CacheMissCount",
          "mode": 0,
          "namespace": "AWS/ApiGateway",
          "options": {
            "showDisabledItems": false
          },
          "period": "$agg",
          "refId": "B",
          "region": "$region",
          "statistics": [
            "Sum"
          ]
        }
      ],
      "thresholds": [],
      "timeFrom": null,
      "timeRegions": [],
      "timeShift": null,
      "title": "CacheHitCount / CacheMissCount",
      "tooltip": {
        "msResolution": false,
        "shared": true,
        "sort": 0,
        "value_type": "cumulative"
      },
      "type": "graph",
      "xaxis": {
        "buckets": null,
        "mode": "time",
        "name": null,
        "show": true,
        "values": []
      },
      "yaxes": [
        {
          "$$hashKey": "object:207",
          "format": "none",
          "label": null,
          "logBase": 1,
          "max": null,
          "min": 0,
          "show": true
        },
        {
          "$$hashKey": "object:208",
          "format": "none",
          "label": null,
          "logBase": 1,
          "max": null,
          "min": 0,
          "show": true
        }
      ],
      "yaxis": {
        "align": false,
        "alignLevel": null
      }
    },
    {
      "content": "<a style=\"float: right\" href=\"http://www.monitoringartist.com\" target=\"_blank\" title=\"Dashboard maintained by Monitoring Artist - DevOps / Docker / Kubernetes / AWS ECS / Google GCP / Zabbix / Zenoss / Terraform / Monitoring\"><img src=\"https://monitoringartist.github.io/monitoring-artist-logo-grafana.png\" height=\"30px\" /></a>\n<a style=\"float: left\"  target=\"_blank\" href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-metrics-and-dimensions.html\">AWS CloudWatch API Gateway documentation</a><br/>\n<a style=\"float: left\"  target=\"_blank\" href=\"https://grafana.com/dashboards/1516\">Installed from Grafana.com dashboards</a>\n<div style=\"clear:both; width:100%;height:0;font-size:0;\"></div>",
      "datasource": "",
      "editable": true,
      "error": false,
      "fieldConfig": {
        "defaults": {
          "custom": {}
        },
        "overrides": []
      },
      "gridPos": {
        "h": 3,
        "w": 24,
        "x": 0,
        "y": 28
      },
      "id": 2,
      "links": [],
      "mode": "html",
      "options": {
        "content": "<a href=\"http://www.monitoringartist.com\" target=\"_blank\" title=\"Dashboard maintained by Monitoring Artist - DevOps / Docker / Kubernetes / AWS ECS / Google GCP / Zabbix / Zenoss / Terraform / Monitoring\"><img src=\"https://monitoringartist.github.io/monitoring-artist-logo-grafana.png\" height=\"30px\" /></a> | \n<a target=\"_blank\" href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-metrics-and-dimensions.html\">AWS CloudWatch API Gateway documentation</a> | \n<a target=\"_blank\" href=\"https://grafana.com/dashboards/1516\">Installed from Grafana.com dashboards</a>",
        "mode": "html"
      },
      "pluginVersion": "7.1.0",
      "title": "Documentation",
      "type": "text"
    }
  ],
  "refresh": false,
  "schemaVersion": 26,
  "style": "dark",
  "tags": [
    "monitoringartist",
    "cloudwatch"
  ],
  "templating": {
    "list": [
      {
        "current": {},
        "hide": 0,
        "includeAll": false,
        "label": "Datasource",
        "multi": false,
        "name": "datasource",
        "options": [],
        "query": "cloudwatch",
        "refresh": 1,
        "regex": "",
        "skipUrlSync": false,
        "type": "datasource"
      },
      {
        "auto": true,
        "auto_count": 30,
        "auto_min": "10s",
        "current": {
          "selected": true,
          "text": "auto",
          "value": "$__auto_interval_agg"
        },
        "hide": 0,
        "label": "Aggregation",
        "name": "agg",
        "options": [
          {
            "selected": true,
            "text": "auto",
            "value": "$__auto_interval_agg"
          },
          {
            "selected": false,
            "text": "1s",
            "value": "1s"
          },
          {
            "selected": false,
            "text": "5s",
            "value": "5s"
          },
          {
            "selected": false,
            "text": "10s",
            "value": "10s"
          },
          {
            "selected": false,
            "text": "30s",
            "value": "30s"
          },
          {
            "selected": false,
            "text": "1m",
            "value": "1m"
          },
          {
            "selected": false,
            "text": "5m",
            "value": "5m"
          },
          {
            "selected": false,
            "text": "15m",
            "value": "15m"
          },
          {
            "selected": false,
            "text": "1h",
            "value": "1h"
          },
          {
            "selected": false,
            "text": "6h",
            "value": "6h"
          },
          {
            "selected": false,
            "text": "1d",
            "value": "1d"
          },
          {
            "selected": false,
            "text": "7d",
            "value": "7d"
          },
          {
            "selected": false,
            "text": "30d",
            "value": "30d"
          }
        ],
        "query": "1s,5s,10s,30s,1m,5m,15m,1h,6h,1d,7d,30d",
        "refresh": 2,
        "skipUrlSync": false,
        "type": "interval"
      },
      {
        "allValue": null,
        "current": {},
        "datasource": "$datasource",
        "definition": "regions()",
        "hide": 0,
        "includeAll": false,
        "label": "Region",
        "multi": false,
        "name": "region",
        "options": [],
        "query": "regions()",
        "refresh": 1,
        "regex": "",
        "skipUrlSync": false,
        "sort": 1,
        "tagValuesQuery": "",
        "tags": [],
        "tagsQuery": "",
        "type": "query",
        "useTags": false
      },
      {
        "allValue": null,
        "current": {},
        "datasource": "$datasource",
        "definition": "dimension_values($region,AWS/ApiGateway,Count,ApiName)",
        "hide": 0,
        "includeAll": false,
        "label": "ApiName",
        "multi": false,
        "name": "apiname",
        "options": [],
        "query": "dimension_values($region,AWS/ApiGateway,Count,ApiName)",
        "refresh": 1,
        "regex": "",
        "skipUrlSync": false,
        "sort": 1,
        "tagValuesQuery": "",
        "tags": [],
        "tagsQuery": "",
        "type": "query",
        "useTags": false
      },
      {
        "allValue": "*",
        "current": {},
        "datasource": "$datasource",
        "definition": "dimension_values($region,AWS/ApiGateway,Count,Stage, {\"ApiName\": \"$apiname\"})",
        "hide": 0,
        "includeAll": false,
        "label": "AND Stage",
        "multi": false,
        "name": "stage",
        "options": [],
        "query": "dimension_values($region,AWS/ApiGateway,Count,Stage, {\"ApiName\": \"$apiname\"})",
        "refresh": 1,
        "regex": "",
        "skipUrlSync": false,
        "sort": 1,
        "tagValuesQuery": "",
        "tags": [],
        "tagsQuery": "",
        "type": "query",
        "useTags": false
      }
    ]
  },
  "time": {
    "from": "now-7d",
    "to": "now"
  },
  "timepicker": {
    "refresh_intervals": [
      "5s",
      "10s",
      "30s",
      "1m",
      "5m",
      "15m",
      "30m",
      "1h",
      "2h",
      "1d"
    ],
    "time_options": [
      "5m",
      "15m",
      "1h",
      "6h",
      "12h",
      "24h",
      "2d",
      "7d",
      "30d"
    ]
  },
  "timezone": "browser",
  "title": "AWS API Gateway",
  "uid": "AWSAPIGat",
  "version": 1
}