Return Metric Names

On this page

Resource

Request Path Parameters
Request Query Parameters
Request Body Parameters
Response
Example Request
Example Response
Response Header
Response Body

Cloud Manager will no longer support Automation, Backup, and Monitoring for MongoDB 3.6 and 4.0 after August 30th, 2024. Please upgrade your MongoDB deployment or migrate to Atlas.

OAuth 2.0 authentication for programmatic access to Cloud Manager is available as a Preview feature.: The feature and the corresponding documentation might change at any time during the Preview period. To use OAuth 2.0 authentication, create a service account to use in your requests to the Cloud Manager Public API.

Return all available query latency metric names and their respective units for the specified project at the time of request.

Base URL: https://cloud.mongodb.com/api/public/v1.0

Resource

GET /groups/{PROJECT-ID}/collStats/metrics

Request Path Parameters

Parameter	Type	Description
PROJECT-ID	string	(Required.) Unique 24-hexadecimal digit string that identifies the project.

Request Query Parameters

All parameters are optional.

Name	Type	Description	Default
pretty	boolean	Indicates whether the response body should be in a prettyprint format.	`false`
envelope	boolean	Indicates whether or not to wrap the response in an envelope.	`false`

Request Body Parameters

This endpoint doesn't use HTTP request body parameters.

Response

Name	Type	Description
groupId	string	Unique 24-hexadecimal digit string that identifies the project.
metrics	array	List that contains all available query latency metric names and their respective units for the specified project at the time of request.

Example Request

curl --user '{PUBLIC-KEY}:{PRIVATE-KEY}' --digest \
 --header 'Accept: application/json' \
 --include \
 --request GET 'https://{CLOUD-MANAGER-HOST}:{PORT}/api/public/v1.0/groups/{PROJECT-ID}/collStats/metrics?pretty=true'

Example Response

Response Header

HTTP/1.1 200 OK
Vary: Accept-Encoding
Content-Type: application/json
Strict-Transport-Security: max-age=300
Date: {dateInUnixFormat}
Connection: keep-alive
Content-Length: {requestLengthInBytes}
X-MongoDB-Service-Version: gitHash={gitHash}; versionString={ApplicationVersion}

Response Body

{
  "groupId": "{PROJECT-ID}",
  "metrics": [
    {
      "metricName": "READS_OPS",
      "units": "SCALAR_PER_SECOND"
    },
    {
      "metricName": "READS_LATENCY",
      "units": "MICROSECONDS_PER_SECOND"
    },
    {
      "metricName": "AVERAGE_READS_LATENCY",
      "units": "MICROSECONDS"
    },
    {
      "metricName": "READS_P50_VALUE",
      "units": "MICROSECONDS"
    },
    {
      "metricName": "READS_P95_VALUE",
      "units": "MICROSECONDS"
    },
    {
      "metricName": "READS_P99_VALUE",
      "units": "MICROSECONDS"
    },
    {
      "metricName": "WRITES_OPS",
      "units": "SCALAR_PER_SECOND"
    },
    {
      "metricName": "WRITES_LATENCY",
      "units": "MICROSECONDS_PER_SECOND"
    },
    {
      "metricName": "AVERAGE_WRITES_LATENCY",
      "units": "MICROSECONDS"
    },
    {
      "metricName": "WRITES_P50_VALUE",
      "units": "MICROSECONDS"
    },
    {
      "metricName": "WRITES_P95_VALUE",
      "units": "MICROSECONDS"
    },
    {
      "metricName": "WRITES_P99_VALUE",
      "units": "MICROSECONDS"
    },
    {
      "metricName": "COMMANDS_OPS",
      "units": "SCALAR_PER_SECOND"
    },
    {
      "metricName": "COMMANDS_LATENCY",
      "units": "MICROSECONDS_PER_SECOND"
    },
    {
      "metricName": "AVERAGE_COMMANDS_LATENCY",
      "units": "MICROSECONDS"
    },
    {
      "metricName": "COMMANDS_P50_VALUE",
      "units": "MICROSECONDS"
    },
    {
      "metricName": "COMMANDS_P95_VALUE",
      "units": "MICROSECONDS"
    },
    {
      "metricName": "COMMANDS_P99_VALUE",
      "units": "MICROSECONDS"
    },
    {
      "metricName": "TOTAL_OPS",
      "units": "SCALAR_PER_SECOND"
    },
    {
      "metricName": "TOTAL_LATENCY",
      "units": "MICROSECONDS_PER_SECOND"
    },
    {
      "metricName": "AVERAGE_TOTAL_OPS_LATENCY",
      "units": "MICROSECONDS"
    },
    {
      "metricName": "TOTAL_OPS_P50_VALUE",
      "units": "MICROSECONDS"
    },
    {
      "metricName": "TOTAL_OPS_P95_VALUE",
      "units": "MICROSECONDS"
    },
    {
      "metricName": "TOTAL_OPS_P99_VALUE",
      "units": "MICROSECONDS"
    }
  ]
}

Back

Query Latency

Pin Namespaces