Database - List Metrics

Service:

Cosmos DB Resource Provider

API Version:

2026-03-15

Retrieves the metrics determined by the given filter for the given database account and database.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/databases/{databaseRid}/metrics?api-version=2026-03-15&$filter={$filter}

URI Parameters

Name	In	Required	Type	Description
accountName	path	True	string minLength: 3 maxLength: 50 pattern: ^[a-z0-9]+(-[a-z0-9]+)*	Cosmos DB database account name.
databaseRid	path	True	string	Cosmos DB database rid.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	The name of the resource group. The name is case insensitive.
subscriptionId	path	True	string (uuid)	The ID of the target subscription. The value must be an UUID.
$filter	query	True	string	An OData filter expression that describes a subset of metrics to return. The parameters that can be filtered are name.value (name of the metric, can have an or of multiple names), startTime, endTime, and timeGrain. The supported operator is eq.
api-version	query	True	string minLength: 1	The API version to use for this operation.

Responses

Name	Type	Description
200 OK	MetricListResult	Azure operation completed successfully.
Other Status Codes	ErrorResponse	An unexpected error response.

Security

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

CosmosDBDatabaseGetMetrics

Sample request

HTTP

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/databases/rid/metrics?api-version=2026-03-15&$filter=(name.value eq 'Total Requests') and timeGrain eq duration'PT5M' and startTime eq '2017-11-19T23:53:55.2780000Z' and endTime eq '2017-11-20T00:13:55.2780000Z

Java

/**
 * Samples for Database ListMetrics.
 */
public final class Main {
    /*
     * x-ms-original-file: 2026-03-15/CosmosDBDatabaseGetMetrics.json
     */
    /**
     * Sample code: CosmosDBDatabaseGetMetrics.
     * 
     * @param manager Entry point to CosmosManager.
     */
    public static void cosmosDBDatabaseGetMetrics(com.azure.resourcemanager.cosmos.CosmosManager manager) {
        manager.serviceClient().getDatabases().listMetrics("rg1", "ddb1", "rid",
            "(name.value eq 'Total Requests') and timeGrain eq duration'PT5M' and startTime eq '2017-11-19T23:53:55.2780000Z' and endTime eq '2017-11-20T00:13:55.2780000Z",
            com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.cosmosdb import CosmosDBManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-cosmosdb
# USAGE
    python cosmos_db_database_get_metrics.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = CosmosDBManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="SUBSCRIPTION_ID",
    )

    response = client.database.list_metrics(
        resource_group_name="rg1",
        account_name="ddb1",
        database_rid="rid",
        filter="(name.value eq 'Total Requests') and timeGrain eq duration'PT5M' and startTime eq '2017-11-19T23:53:55.2780000Z' and endTime eq '2017-11-20T00:13:55.2780000Z",
    )
    for item in response:
        print(item)


# x-ms-original-file: 2026-03-15/CosmosDBDatabaseGetMetrics.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armcosmos_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/cosmos/armcosmos/v4"
)

// Generated from example definition: 2026-03-15/CosmosDBDatabaseGetMetrics.json
func ExampleDatabaseClient_NewListMetricsPager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armcosmos.NewClientFactory("00000000-1111-2222-3333-444444444444", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewDatabaseClient().NewListMetricsPager("rg1", "ddb1", "rid", "(name.value eq 'Total Requests') and timeGrain eq duration'PT5M' and startTime eq '2017-11-19T23:53:55.2780000Z' and endTime eq '2017-11-20T00:13:55.2780000Z", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page = armcosmos.DatabaseClientListMetricsResponse{
		// 	MetricListResult: armcosmos.MetricListResult{
		// 		Value: []*armcosmos.Metric{
		// 			{
		// 				TimeGrain: to.Ptr("PT5M"),
		// 				StartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-11-19T23:53:55.2780000Z"); return t}()),
		// 				EndTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-11-20T00:13:55.2780000Z"); return t}()),
		// 				Unit: to.Ptr(armcosmos.UnitTypeCount),
		// 				MetricValues: []*armcosmos.MetricValue{
		// 					{
		// 						Timestamp: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-11-19T23:53:55.2780000Z"); return t}()),
		// 						Total: to.Ptr[float64](0),
		// 						Count: to.Ptr[int32](0),
		// 						Average: to.Ptr[float64](0),
		// 					},
		// 					{
		// 						Timestamp: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-11-19T23:58:55.2780000Z"); return t}()),
		// 						Total: to.Ptr[float64](0),
		// 						Count: to.Ptr[int32](0),
		// 						Average: to.Ptr[float64](0),
		// 					},
		// 					{
		// 						Timestamp: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-11-20T00:03:55.2780000Z"); return t}()),
		// 						Total: to.Ptr[float64](0),
		// 						Count: to.Ptr[int32](0),
		// 						Average: to.Ptr[float64](0),
		// 					},
		// 					{
		// 						Timestamp: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-11-20T00:08:55.2780000Z"); return t}()),
		// 						Total: to.Ptr[float64](0),
		// 						Count: to.Ptr[int32](0),
		// 						Average: to.Ptr[float64](0),
		// 					},
		// 				},
		// 				Name: &armcosmos.MetricName{
		// 					Value: to.Ptr("Total Requests"),
		// 					LocalizedValue: to.Ptr("Total Requests"),
		// 				},
		// 			},
		// 		},
		// 	},
		// }
	}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { CosmosDBManagementClient } = require("@azure/arm-cosmosdb");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to retrieves the metrics determined by the given filter for the given database account and database.
 *
 * @summary retrieves the metrics determined by the given filter for the given database account and database.
 * x-ms-original-file: 2026-03-15/CosmosDBDatabaseGetMetrics.json
 */
async function cosmosDBDatabaseGetMetrics() {
  const credential = new DefaultAzureCredential();
  const subscriptionId = "00000000-1111-2222-3333-444444444444";
  const client = new CosmosDBManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (const item of client.database.listMetrics(
    "rg1",
    "ddb1",
    "rid",
    "(name.value eq 'Total Requests') and timeGrain eq duration'PT5M' and startTime eq '2017-11-19T23:53:55.2780000Z' and endTime eq '2017-11-20T00:13:55.2780000Z",
  )) {
    resArray.push(item);
  }

  console.log(resArray);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample response

Status code:

200

{
  "value": [
    {
      "timeGrain": "PT5M",
      "startTime": "2017-11-19T23:53:55.2780000Z",
      "endTime": "2017-11-20T00:13:55.2780000Z",
      "unit": "Count",
      "metricValues": [
        {
          "timestamp": "2017-11-19T23:53:55.2780000Z",
          "total": 0,
          "_count": 0,
          "average": 0
        },
        {
          "timestamp": "2017-11-19T23:58:55.2780000Z",
          "total": 0,
          "_count": 0,
          "average": 0
        },
        {
          "timestamp": "2017-11-20T00:03:55.2780000Z",
          "total": 0,
          "_count": 0,
          "average": 0
        },
        {
          "timestamp": "2017-11-20T00:08:55.2780000Z",
          "total": 0,
          "_count": 0,
          "average": 0
        }
      ],
      "name": {
        "value": "Total Requests",
        "localizedValue": "Total Requests"
      }
    }
  ]
}

Definitions

Name	Description
ErrorResponse	Error Response.
Metric	Metric data
MetricListResult	The response to a list metrics request.
MetricName	A metric name.
MetricValue	Represents metrics values.
UnitType	The unit of the metric.

ErrorResponse

Object

Error Response.

Name	Type	Description
code	string	Error code.
message	string	Error message indicating why the operation failed.

Metric

Object

Metric data

Name	Type	Description
endTime	string (date-time)	The end time for the metric (ISO-8601 format).
metricValues	MetricValue[]	The metric values for the specified time window and timestep.
name	MetricName	The name information for the metric.
startTime	string (date-time)	The start time for the metric (ISO-8601 format).
timeGrain	string	The time grain to be used to summarize the metric values.
unit	UnitType	The unit of the metric.

MetricListResult

Object

The response to a list metrics request.

Name	Type	Description
nextLink	string
value	Metric[]	The list of metrics for the account.

MetricName

Object

A metric name.

Name	Type	Description
localizedValue	string	The friendly name of the metric.
value	string	The name of the metric.

MetricValue

Object

Represents metrics values.

Name	Type	Description
_count	integer (int32)	The number of values for the metric.
average	number (double)	The average value of the metric.
maximum	number (double)	The max value of the metric.
minimum	number (double)	The min value of the metric.
timestamp	string (date-time)	The metric timestamp (ISO-8601 format).
total	number (double)	The total value of the metric.

UnitType

Enumeration

The unit of the metric.

Value	Description
Count
Bytes
Seconds
Percent
CountPerSecond
BytesPerSecond
Milliseconds