Returns time series of the requested measurements for every shard of the specified sharded cluster, one series per shard and measurement. 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.
- Project Read Only
Path parameters
-
Unique 24-hexadecimal digit string that identifies your project. Use the /groups 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.
Format should match the following pattern:
^([a-f0-9]{24})$. -
Human-readable label that identifies the cluster.
Format should match the following pattern:
^[a-zA-Z0-9][a-zA-Z0-9-]*$.
Query parameters
-
Flag that indicates whether Application wraps the response in an
envelopeJSON 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.Default value is
false. -
Flag that indicates whether the response body should be in the prettyprint format.
Default value is
false.Prettyprint -
One or more measurements to return. If omitted, the resource returns all measurements. To specify multiple values for
m, repeat themparameter for each value.At least
1but not more than20elements. Values areSYSTEM_CPU,SYSTEM_MEMORY,SYSTEM_NETWORK,DISK_IOPS,DISK_LATENCY,DISK_THROUGHPUT,DISK_SPACE,CONNECTIONS,OPCOUNTERS,QUEUES, orREPLICATION_LAG. -
Interval between consecutive data points, in ISO 8601 duration format. If omitted, MongoDB Cloud chooses the resolution from the width of the window.
Values are
PT30S,PT1M,PT3M,PT15M,PT1H, orPT3H. -
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.
-
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.
-
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.
-
Members of each shard whose readings are averaged into the shard's series.
Values are
ALL,PRIMARIES, orSECONDARIES. Default value isALL.
atlas api shardingInsights listShardMetricMeasurements --helpimport (
"os"
"context"
"log"
sdk "go.mongodb.org/atlas-sdk/v20250312001/admin"
)
func main() {
ctx := context.Background()
clientID := os.Getenv("MONGODB_ATLAS_CLIENT_ID")
clientSecret := os.Getenv("MONGODB_ATLAS_CLIENT_SECRET")
// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth
client, err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))
if err != nil {
log.Fatalf("Error: %v", err)
}
params = &sdk.ListGroupClusterShardMetricMeasurementsApiParams{}
sdkResp, httpResp, err := client.ShardingInsightsApi.
ListGroupClusterShardMetricMeasurementsWithParams(ctx, params).
Execute()
}
curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
--header "Accept: application/vnd.atlas.2025-03-12+json" \
-X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/shardMetrics:listMeasurements?pretty=true"curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
--digest --include \
--header "Accept: application/vnd.atlas.2025-03-12+json" \
-X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/shardMetrics:listMeasurements?pretty=true"# Headers
# Payload
{
"clusterName": "string",
"end": "2026-05-04T09:42:00Z",
"granularity": "PT30S",
"groupId": "32b6e34b3d91647abb20e7b8",
"measurements": [
{
"dataPoints": [
{
"timestamp": "2026-05-04T09:42:00Z",
"value": 42.0
}
],
"name": "SYSTEM_CPU",
"replicaSetName": "atlas-12vorz-shard-0",
"units": "BYTES"
}
],
"start": "2026-05-04T09:42:00Z"
}{
"detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
"error": 400,
"errorCode": "VALIDATION_ERROR",
"reason": "Bad Request"
}{
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"error": 401,
"errorCode": "NOT_ORG_GROUP_CREATOR",
"reason": "Unauthorized"
}{
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"error": 403,
"errorCode": "CANNOT_CHANGE_GROUP_NAME",
"reason": "Forbidden"
}{
"detail": "(This is just an example, the exception may not be related to this endpoint) Cannot find resource AWS",
"error": 404,
"errorCode": "RESOURCE_NOT_FOUND",
"reason": "Not Found"
}{
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"error": 429,
"errorCode": "RATE_LIMITED",
"reason": "Too Many Requests"
}{
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"error": 500,
"errorCode": "UNEXPECTED_ERROR",
"reason": "Internal Server Error"
}