Returns time series of the requested measurements for every shard of the specified sharded cluster, one series per shard and measurement.
The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link.
Each shard's series averages the readings of its member processes selected by nodeType. Each series carries one data point per granularity interval, starting at start and not passing end. A data point's value is null when MongoDB Cloud has no reading for that interval; this includes the first minutes after a cluster or shard is created, before its metrics are collected, so null must not be read as zero load. Set period, or set both start and end; when neither is set, the response covers the last hour. A request whose window and granularity would produce more than 1000 data points per series is rejected.
This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/es/docs/api/doc/atlas-admin-api-v2/operation/operation-listgroupclustershardmetricmeasurements.
For more information and examples, see the referenced API documentation linked above.
Syntax
Command Syntax
atlas api shardingInsights listShardMetricMeasurements [options]Options
Name | Type | Required | Description |
|---|---|---|---|
--clusterName | string | true | Human-readable label that identifies the cluster. |
--end | string | false | Date and time when MongoDB Cloud stops reporting the metrics. This parameter expresses its value in the ISO 8601 timestamp format in UTC. Include this parameter when you do not set period. |
--envelope | envelope | false | Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body. |
--granularity | string | false | Interval between consecutive data points, in ISO 8601 duration format. If omitted, MongoDB Cloud chooses the resolution from the width of the window. |
--groupId | string | true | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
-h, --help | false | help for listShardMetricMeasurements | |
--m | m | false | One or more measurements to return. If omitted, the resource returns all measurements. To specify multiple values for m, repeat the |
--nodeType | string | false | Members of each shard whose readings are averaged into the shard's series. |
-o, --output | string | false | preferred api format, can be ["json", go-template] This value defaults to "json". |
--outputFile | string | false | file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) |
--period | string | false | Duration over which Atlas reports the metrics. This parameter expresses its value in the ISO 8601 duration format in UTC. Include this parameter when you do not set start and end. |
--pretty | false | Flag that indicates whether the response body should be in the prettyprint format. | |
--start | string | false | Date and time when MongoDB Cloud begins reporting the metrics. This parameter expresses its value in the ISO 8601 timestamp format in UTC. Include this parameter when you do not set period. |
--version | string | false | API version to use when calling the Atlas API endpoints [options: "2025-03-12"]. If not set by the user, defaults to the latest version or the profile's api_version config value if set. This value defaults to "2025-03-12". |
Inherited Options
Name | Type | Required | Description |
|---|---|---|---|
-P, --profile | string | false | Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. |
Examples
atlas api shardingInsights listShardMetricMeasurements --version 2025-03-12 --clusterName [clusterName] --granularity PT1M --groupId 32b6e34b3d91647abb20e7b8 --period PT10H