Return All Atlas Search Metric Types for One Process

GET /api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics

Returns all Atlas Search metric types available for one process in the specified project. You must have the Project Read Only or higher role to view the Atlas Search metric types.

Path parameters

  • processId string Required

    Combination of hostname and IANA port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (mongod or mongos). The port must be the IANA port on which the MongoDB process listens for requests.

    Format should match the following pattern: ^([0-9]{1,3}\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\.){1,10}[a-z]+)?(\:[0-9]{4,5})$.

  • groupId string Required

    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})$.

Query parameters

  • envelope boolean

    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.

    Default value is false.

Responses

  • 200 application/vnd.atlas.2023-01-01+json

    OK

    Hide response attributes Show response attributes object
    • groupId string Required

      Unique 24-hexadecimal digit string that identifies the project.

      Format should match the following pattern: ^([a-f0-9]{24})$.

    • hardwareMetrics array[object]

      List that contains all host compute, memory, and storage utilization dedicated to Atlas Search when MongoDB Atlas received this request.

      Measurement of one Atlas Search status when MongoDB Atlas received this request.

      Hide hardwareMetrics attributes Show hardwareMetrics attributes object
      • metricName string Required

        Human-readable label that identifies this Atlas Search hardware, status, or index measurement.

        Values are INDEX_SIZE_ON_DISK, NUMBER_OF_DELETES, NUMBER_OF_ERROR_QUERIES, NUMBER_OF_GETMORE_COMMANDS, NUMBER_OF_INDEX_FIELDS, NUMBER_OF_INSERTS, NUMBER_OF_SUCCESS_QUERIES, NUMBER_OF_UPDATES, REPLICATION_LAG, TOTAL_NUMBER_OF_QUERIES, FTS_DISK_USAGE, FTS_PROCESS_CPU_KERNEL, FTS_PROCESS_CPU_USER, FTS_PROCESS_NORMALIZED_CPU_KERNEL, FTS_PROCESS_NORMALIZED_CPU_USER, FTS_PROCESS_RESIDENT_MEMORY, FTS_PROCESS_SHARED_MEMORY, FTS_PROCESS_VIRTUAL_MEMORY, JVM_CURRENT_MEMORY, JVM_MAX_MEMORY, or PAGE_FAULTS.

      • units string Required

        Unit of measurement that applies to this Atlas Search metric.

        Values are BYTES, BYTES_PER_SECOND, GIGABYTES, GIGABYTES_PER_HOUR, KILOBYTES, MEGABYTES, MEGABYTES_PER_SECOND, MILLISECONDS, MILLISECONDS_LOGSCALE, PERCENT, SCALAR, SCALAR_PER_SECOND, or SECONDS.

    • indexMetrics array[object]

      List that contains all performance and utilization measurements that Atlas Search index performed by the time MongoDB Atlas received this request.

      Measurement of one Atlas Search status when MongoDB Atlas received this request.

      Hide indexMetrics attributes Show indexMetrics attributes object
      • metricName string Required

        Human-readable label that identifies this Atlas Search hardware, status, or index measurement.

        Values are INDEX_SIZE_ON_DISK, NUMBER_OF_DELETES, NUMBER_OF_ERROR_QUERIES, NUMBER_OF_GETMORE_COMMANDS, NUMBER_OF_INDEX_FIELDS, NUMBER_OF_INSERTS, NUMBER_OF_SUCCESS_QUERIES, NUMBER_OF_UPDATES, REPLICATION_LAG, TOTAL_NUMBER_OF_QUERIES, FTS_DISK_USAGE, FTS_PROCESS_CPU_KERNEL, FTS_PROCESS_CPU_USER, FTS_PROCESS_NORMALIZED_CPU_KERNEL, FTS_PROCESS_NORMALIZED_CPU_USER, FTS_PROCESS_RESIDENT_MEMORY, FTS_PROCESS_SHARED_MEMORY, FTS_PROCESS_VIRTUAL_MEMORY, JVM_CURRENT_MEMORY, JVM_MAX_MEMORY, or PAGE_FAULTS.

      • units string Required

        Unit of measurement that applies to this Atlas Search metric.

        Values are BYTES, BYTES_PER_SECOND, GIGABYTES, GIGABYTES_PER_HOUR, KILOBYTES, MEGABYTES, MEGABYTES_PER_SECOND, MILLISECONDS, MILLISECONDS_LOGSCALE, PERCENT, SCALAR, SCALAR_PER_SECOND, or SECONDS.

    • processId string Required

      Hostname and port that identifies the process.

      Format should match the following pattern: ^([0-9]{1,3}\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\.){1,10}[a-z]+)?(\:[0-9]{4,5})$.

    • statusMetrics array[object]

      List that contains all available Atlas Search status metrics when MongoDB Atlas received this request.

      Measurement of one Atlas Search status when MongoDB Atlas received this request.

      Hide statusMetrics attributes Show statusMetrics attributes object
      • metricName string Required

        Human-readable label that identifies this Atlas Search hardware, status, or index measurement.

        Values are INDEX_SIZE_ON_DISK, NUMBER_OF_DELETES, NUMBER_OF_ERROR_QUERIES, NUMBER_OF_GETMORE_COMMANDS, NUMBER_OF_INDEX_FIELDS, NUMBER_OF_INSERTS, NUMBER_OF_SUCCESS_QUERIES, NUMBER_OF_UPDATES, REPLICATION_LAG, TOTAL_NUMBER_OF_QUERIES, FTS_DISK_USAGE, FTS_PROCESS_CPU_KERNEL, FTS_PROCESS_CPU_USER, FTS_PROCESS_NORMALIZED_CPU_KERNEL, FTS_PROCESS_NORMALIZED_CPU_USER, FTS_PROCESS_RESIDENT_MEMORY, FTS_PROCESS_SHARED_MEMORY, FTS_PROCESS_VIRTUAL_MEMORY, JVM_CURRENT_MEMORY, JVM_MAX_MEMORY, or PAGE_FAULTS.

      • units string Required

        Unit of measurement that applies to this Atlas Search metric.

        Values are BYTES, BYTES_PER_SECOND, GIGABYTES, GIGABYTES_PER_HOUR, KILOBYTES, MEGABYTES, MEGABYTES_PER_SECOND, MILLISECONDS, MILLISECONDS_LOGSCALE, PERCENT, SCALAR, SCALAR_PER_SECOND, or SECONDS.

  • 400 application/json

    Bad Request.

    Hide response attributes Show response attributes object
    • badRequestDetail object

      Bad request detail.

      Hide badRequestDetail attribute Show badRequestDetail attribute object
      • fields array[object]

        Describes all violations in a client request.

        Hide fields attributes Show fields attributes object
        • description string Required

          A description of why the request element is bad.

        • field string Required

          A path that leads to a field in the request body.

    • detail string

      Describes the specific conditions or reasons that cause each type of error.

    • error integer(int32) Required

      HTTP status code returned with this error.

      External documentation
    • errorCode string Required

      Application error code returned with this error.

    • parameters array[object]

      Parameters used to give more information about the error.

    • reason string

      Application error message returned with this error.

  • 401 application/json

    Unauthorized.

    Hide response attributes Show response attributes object
    • badRequestDetail object

      Bad request detail.

      Hide badRequestDetail attribute Show badRequestDetail attribute object
      • fields array[object]

        Describes all violations in a client request.

        Hide fields attributes Show fields attributes object
        • description string Required

          A description of why the request element is bad.

        • field string Required

          A path that leads to a field in the request body.

    • detail string

      Describes the specific conditions or reasons that cause each type of error.

    • error integer(int32) Required

      HTTP status code returned with this error.

      External documentation
    • errorCode string Required

      Application error code returned with this error.

    • parameters array[object]

      Parameters used to give more information about the error.

    • reason string

      Application error message returned with this error.

  • 403 application/json

    Forbidden.

    Hide response attributes Show response attributes object
    • badRequestDetail object

      Bad request detail.

      Hide badRequestDetail attribute Show badRequestDetail attribute object
      • fields array[object]

        Describes all violations in a client request.

        Hide fields attributes Show fields attributes object
        • description string Required

          A description of why the request element is bad.

        • field string Required

          A path that leads to a field in the request body.

    • detail string

      Describes the specific conditions or reasons that cause each type of error.

    • error integer(int32) Required

      HTTP status code returned with this error.

      External documentation
    • errorCode string Required

      Application error code returned with this error.

    • parameters array[object]

      Parameters used to give more information about the error.

    • reason string

      Application error message returned with this error.

  • 404 application/json

    Not Found.

    Hide response attributes Show response attributes object
    • badRequestDetail object

      Bad request detail.

      Hide badRequestDetail attribute Show badRequestDetail attribute object
      • fields array[object]

        Describes all violations in a client request.

        Hide fields attributes Show fields attributes object
        • description string Required

          A description of why the request element is bad.

        • field string Required

          A path that leads to a field in the request body.

    • detail string

      Describes the specific conditions or reasons that cause each type of error.

    • error integer(int32) Required

      HTTP status code returned with this error.

      External documentation
    • errorCode string Required

      Application error code returned with this error.

    • parameters array[object]

      Parameters used to give more information about the error.

    • reason string

      Application error message returned with this error.

  • 429 application/json

    Too Many Requests.

    Hide response attributes Show response attributes object
    • badRequestDetail object

      Bad request detail.

      Hide badRequestDetail attribute Show badRequestDetail attribute object
      • fields array[object]

        Describes all violations in a client request.

        Hide fields attributes Show fields attributes object
        • description string Required

          A description of why the request element is bad.

        • field string Required

          A path that leads to a field in the request body.

    • detail string

      Describes the specific conditions or reasons that cause each type of error.

    • error integer(int32) Required

      HTTP status code returned with this error.

      External documentation
    • errorCode string Required

      Application error code returned with this error.

    • parameters array[object]

      Parameters used to give more information about the error.

    • reason string

      Application error message returned with this error.

  • 500 application/json

    Internal Server Error.

    Hide response attributes Show response attributes object
    • badRequestDetail object

      Bad request detail.

      Hide badRequestDetail attribute Show badRequestDetail attribute object
      • fields array[object]

        Describes all violations in a client request.

        Hide fields attributes Show fields attributes object
        • description string Required

          A description of why the request element is bad.

        • field string Required

          A path that leads to a field in the request body.

    • detail string

      Describes the specific conditions or reasons that cause each type of error.

    • error integer(int32) Required

      HTTP status code returned with this error.

      External documentation
    • errorCode string Required

      Application error code returned with this error.

    • parameters array[object]

      Parameters used to give more information about the error.

    • reason string

      Application error message returned with this error.

GET /api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics
atlas api listMetricTypes --help
import (
	"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")

	client, err := sdk.NewClient(
		sdk.UseOAuthAuth(clientID, clientSecret),
		sdk.UseBaseURL(url))

	if err != nil {
		log.Fatalf("Error: %v", err)
	}

	params = &sdk.ListMetricTypesApiParams{}
	sdkResp, httpResp, err := client.MonitoringandLogsApi.
		ListMetricTypesWithParams(ctx, params).
		Execute()
}
curl --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}/hosts/{processId}/fts/metrics?pretty=true"
curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
  --digest \
  --header "Accept: application/vnd.atlas.2025-03-12+json" \
  -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics?pretty=true"
Response examples (200)
{
  "groupId": "32b6e34b3d91647abb20e7b8",
  "hardwareMetrics": [
    {
      "metricName": "INDEX_SIZE_ON_DISK",
      "units": "BYTES"
    }
  ],
  "indexMetrics": [
    {
      "metricName": "INDEX_SIZE_ON_DISK",
      "units": "BYTES"
    }
  ],
  "links": [
    {
      "href": "https://cloud.mongodb.com/api/atlas",
      "rel": "self"
    }
  ],
  "processId": "mongodb.example.com:27017",
  "statusMetrics": [
    {
      "metricName": "INDEX_SIZE_ON_DISK",
      "units": "BYTES"
    }
  ]
}
Response examples (400)
{
  "error": 400,
  "detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
  "reason": "Bad Request",
  "errorCode": "VALIDATION_ERROR"
}
Response examples (401)
{
  "error": 401,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Unauthorized",
  "errorCode": "NOT_ORG_GROUP_CREATOR"
}
Response examples (403)
{
  "error": 403,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Forbidden",
  "errorCode": "CANNOT_CHANGE_GROUP_NAME"
}
Response examples (404)
{
  "error": 404,
  "detail": "(This is just an example, the exception may not be related to this endpoint) Cannot find resource AWS",
  "reason": "Not Found",
  "errorCode": "RESOURCE_NOT_FOUND"
}
Response examples (429)
{
  "error": 429,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Too Many Requests",
  "errorCode": "RATE_LIMITED"
}
Response examples (500)
{
  "error": 500,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Internal Server Error",
  "errorCode": "UNEXPECTED_ERROR"
}