How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

MongoDB Performance Advisor API

Returns suggested indexes and slow query data for a database deployment. Also enables or disables MongoDB Cloud-managed slow operation thresholds. To view field values in a sample query, you must have the Project Data Access Read Only role or higher. Otherwise, MongoDB Cloud returns redacted data rather than the field values.

MongoDB Performance Advisor API is one of 53 APIs that MongoDB publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Performance Advisor. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, rate-limit docs, and a changelog.

This API exposes 11 operations across 10 paths, and defines 19 schemas. It is described by OpenAPI 3.2.0, at version 2.0.

Requests are made against a single base URL, https://cloud.mongodb.com.

11 operations 10 paths 19 schemas 1 DELETE8 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2.0
Base URL
https://cloud.mongodb.com/api/atlas/v2
Authentication
HTTP Digest, OAuth 2.0
Terms of Service
Resource Areas
1

Authentication & Security 2

MongoDB Performance Advisor API declares 2 security schemes for authenticating requests. It uses HTTP digest authentication (DigestAuth). It supports OAuth 2.0 (ServiceAccounts) using the clientCredentials flow. By default, every request must be authenticated.

  • ServiceAccounts — Learn more about [Service Accounts](https://www.mongodb.com/docs/atlas/api/service-accounts-overview).

Paths & Operations 11

Across 10 paths, the API surfaces 11 operations — 1 DELETE, 8 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Performance Advisor 11

Returns suggested indexes and slow query data for a database deployment. Also enables or disables MongoDB Cloud-managed slow operation thresholds. To view field values in a sample…

GET
/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/performanceAdvisor/dropIndexSuggestions
Return All Suggested Indexes to Drop
listGroupClusterPerformanceAdvisorDropIndexSuggestions 2 params → 200400401403404429500
GET
/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/performanceAdvisor/schemaAdvice
Return Schema Advice
listGroupClusterPerformanceAdvisorSchemaAdvice 2 params → 200400401403404429500
GET
/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/performanceAdvisor/suggestedIndexes
Return All Suggested Indexes
listGroupClusterPerformanceAdvisorSuggestedIndexes 6 params → 200400401403404429500
GET
/api/atlas/v2/groups/{groupId}/managedSlowMs
Return Managed Slow Operation Threshold Status
getGroupManagedSlowMs 3 params → 200401403404429500
DELETE
/api/atlas/v2/groups/{groupId}/managedSlowMs/disable
Disable Managed Slow Operation Threshold
disableGroupManagedSlowMs 3 params → 204401403404429500
POST
/api/atlas/v2/groups/{groupId}/managedSlowMs/enable
Enable Managed Slow Operation Threshold
enableGroupManagedSlowMs 3 params → 204401403404429500
GET
/api/atlas/v2/groups/{groupId}/processes/{processId}/performanceAdvisor/namespaces
Return All Namespaces for One Host
listGroupProcessPerformanceAdvisorNamespaces 6 params → 200401403404429500
GET
/api/atlas/v2/groups/{groupId}/processes/{processId}/performanceAdvisor/slowQueryLogs
Return Slow Queries
listGroupProcessPerformanceAdvisorSlowQueryLogs 11 params → 200401403404429500
GET
/api/atlas/v2/groups/{groupId}/processes/{processId}/performanceAdvisor/suggestedIndexes
Return All Suggested Indexes
listGroupProcessPerformanceAdvisorSuggestedIndexes 12 params → 200401403404429500
GET
/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/performanceAdvisor/autoIndexingdeprecated
Return Serverless Auto-Indexing Status
getGroupServerlessPerformanceAdvisorAutoIndexing 4 params → 200401403404429500
POST
/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/performanceAdvisor/autoIndexingdeprecated
Set Serverless Auto-Indexing Status
setGroupServerlessPerformanceAdvisorAutoIndexing 4 params → 200401403404429500

Schemas 19

The contract defines 19 schemas that model the data the API accepts and returns. The most detailed are PerformanceAdvisorSlowQueryMetrics (11 properties), DropIndexSuggestionsIndex (7 properties), ApiError (6 properties), PerformanceAdvisorShape (6 properties). Each schema is shown below with its type and property counts.

SchemaAdvisorItemRecommendation
object
3 properties
SchemaAdvisorResponse
object
1 property
Namespaces
object
1 property
PerformanceAdvisorShape
object
6 properties
ApiError
object
6 properties 2 required
FieldViolation
object
2 properties 2 required
DropIndexSuggestionsIndex
object
7 properties
PerformanceAdvisorSlowQuery
object
Details of one slow query that the Performance Advisor detected.
5 properties
SchemaAdvisorTriggerDetails
object
2 properties
PerformanceAdvisorResponse
object
2 properties
PerformanceAdvisorOpStats
object
Details that this resource returned about the specified query.
4 properties
SchemaAdvisorNamespaceTriggers
object
2 properties
PerformanceAdvisorSlowQueryList
object
1 property
PerformanceAdvisorOperationView
object
2 properties
PerformanceAdvisorSlowQueryMetrics
object
Metrics from a slow query log.
11 properties
DropIndexSuggestionsResponse
object
3 properties
PerformanceAdvisorIndex
object
6 properties
BadRequestDetail
object
Bad request detail.
1 property
NamespaceObj
object
Human-readable label that identifies the namespace on the specified host. The resource expresses this parameter value as . .
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

mongodb-performance-advisor-api-openapi.yml Raw ↑

Other APIs MongoDB publishes across the network.

MongoDB Atlas Data API
MongoDB Atlas App Services Admin API
MongoDB Access Tracking API
MongoDB Activity Feed API
MongoDB Alert Configurations API
MongoDB Alerts API
MongoDB Atlas Search API
MongoDB Auditing API
MongoDB AWS Clusters DNS API
MongoDB Cloud Backups API
MongoDB Cloud Migration Service API
MongoDB Cloud Provider Access API
Where this information came from

This is an independent, third-party profile of MongoDB Performance Advisor API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.