Supported metrics for Microsoft.ApiManagement/service

The following table lists the metrics available for the Microsoft.ApiManagement/service resource type.

Table headings

Metric - The metric display name as it appears in the Azure portal.
Name in Rest API - Metric name as referred to in the REST API.
Unit - Unit of measure.
Aggregation - The default aggregation type. Valid values: Average, Minimum, Maximum, Total, Count.
Dimensions - Dimensions available for the metric.
Time Grains - Intervals at which the metric is sampled. For example, PT1M indicates that the metric is sampled every minute, PT30M every 30 minutes, PT1H every hour, and so on.
DS Export- Whether the metric is exportable to Azure Monitor Logs via Diagnostic Settings.

For information on exporting metrics, see - Metrics export using data collection rules and Create diagnostic settings in Azure Monitor.

For information on metric retention, see Azure Monitor Metrics overview.

For a list of supported logs, see Supported log categories - Microsoft.ApiManagement/service

Category Metric Name in REST API Unit Aggregation Dimensions Time Grains DS Export
Gateway Requests Duration of Backend Requests

Duration of Backend Requests in milliseconds
BackendDuration MilliSeconds Average, Maximum, Minimum Location, Hostname, ApiId PT1M Yes
Capacity Capacity

Utilization metric for ApiManagement service. Note: For skus other than Premium, 'Max' aggregation will show the value as 0.
Capacity Percent Average, Maximum Location PT1M Yes
Gateway WebSocket WebSocket Connection Attempts (Preview)

Count of WebSocket connection attempts based on selected source and destination
ConnectionAttempts Count Total (Sum), Average Location, Source, Destination, State PT1M Yes
Capacity CPU Percentage of Gateway

CPU Percentage of Gateway for SKUv2 services
CpuPercent_Gateway Percent Average, Maximum <none> PT1M Yes
Gateway Requests Overall Duration of Gateway Requests

Overall Duration of Gateway Requests in milliseconds
Duration MilliSeconds Average, Maximum, Minimum Location, Hostname, ApiId PT1M Yes
EventHub Events Dropped EventHub Events

Number of events skipped because of queue size limit reached
EventHubDroppedEvents Count Total (Sum) Location PT1M Yes
EventHub Events Rejected EventHub Events

Number of rejected EventHub events (wrong configuration or unauthorized)
EventHubRejectedEvents Count Total (Sum) Location PT1M Yes
EventHub Events Successful EventHub Events

Number of successful EventHub events
EventHubSuccessfulEvents Count Total (Sum) Location PT1M Yes
EventHub Events Throttled EventHub Events

Number of throttled EventHub events
EventHubThrottledEvents Count Total (Sum) Location PT1M Yes
EventHub Events Timed Out EventHub Events

Number of timed out EventHub events
EventHubTimedoutEvents Count Total (Sum) Location PT1M Yes
EventHub Events Size of EventHub Events

Total size of EventHub events in bytes
EventHubTotalBytesSent Bytes Total (Sum) Location PT1M Yes
EventHub Events Total EventHub Events

Number of events sent to EventHub
EventHubTotalEvents Count Total (Sum) Location PT1M Yes
EventHub Events Failed EventHub Events

Number of failed EventHub events
EventHubTotalFailedEvents Count Total (Sum) Location PT1M Yes
Gateway Requests Failed Gateway Requests (Deprecated)

Number of failures in gateway requests - Use multi-dimension request metric with GatewayResponseCodeCategory dimension instead
FailedRequests Count Total (Sum) Location, Hostname PT1M Yes
Capacity Memory Percentage of Gateway

Memory Percentage of Gateway for SKUv2 services
MemoryPercent_Gateway Percent Average, Maximum <none> PT1M Yes
Network Status Network Connectivity Status of Resources (Preview)

Network Connectivity status of dependent resource types from API Management service
NetworkConnectivity Count Total (Sum), Average Location, ResourceType PT1M Yes
Gateway Requests Other Gateway Requests (Deprecated)

Number of other gateway requests - Use multi-dimension request metric with GatewayResponseCodeCategory dimension instead
OtherRequests Count Total (Sum) Location, Hostname PT1M Yes
Gateway Requests Requests

Gateway request metrics with multiple dimensions
Requests Count Total (Sum), Maximum, Minimum Location, Hostname, LastErrorReason, BackendResponseCode, GatewayResponseCode, BackendResponseCodeCategory, GatewayResponseCodeCategory, ApiId PT1M Yes
Gateway Requests Successful Gateway Requests (Deprecated)

Number of successful gateway requests - Use multi-dimension request metric with GatewayResponseCodeCategory dimension instead
SuccessfulRequests Count Total (Sum) Location, Hostname PT1M Yes
Gateway Requests Total Gateway Requests (Deprecated)

Number of gateway requests - Use multi-dimension request metric with GatewayResponseCodeCategory dimension instead
TotalRequests Count Total (Sum) Location, Hostname PT1M Yes
Gateway Requests Unauthorized Gateway Requests (Deprecated)

Number of unauthorized gateway requests - Use multi-dimension request metric with GatewayResponseCodeCategory dimension instead
UnauthorizedRequests Count Total (Sum) Location, Hostname PT1M Yes
Gateway WebSocket WebSocket Messages (Preview)

Count of WebSocket messages based on selected source and destination
WebSocketMessages Count Total (Sum), Average Location, Source, Destination PT1M Yes

Next steps