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 Query Shape Insights API

The Query Shape Insights API from MongoDB — 4 operation(s) for query shape insights.

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

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

This API exposes 5 operations across 4 paths, and defines 11 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.

5 operations 4 paths 11 schemas 4 GET1 PATCH

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 Query Shape Insights 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 5

Across 4 paths, the API surfaces 5 operations — 4 GET, 1 PATCH. Each is listed below with its method, path, parameters, and response codes.

Query Shape Insights 5
GET
/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/queryShapeInsights/summaries
Return Query Statistic Summaries
listGroupClusterQueryShapeInsightSummaries 12 params → 200400401403404429500
GET
/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/queryShapeInsights/{queryShapeHash}/details
Return Query Shape Details
getGroupClusterQueryShapeInsightDetails 8 params → 200400401403404429500
GET
/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/queryShapes
Return All Query Shapes
listGroupClusterQueryShapes 8 params → 200400401403404429500
GET
/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/queryShapes/{queryShapeHash}
Return One Query Shape
getGroupClusterQueryShape 5 params → 200400401403404429500
PATCH
/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/queryShapes/{queryShapeHash}
Update Query Shape Rejection Status
updateGroupClusterQueryShape 5 params body → 200400401403404429500

Schemas 11

The contract defines 11 schemas that model the data the API accepts and returns. The most detailed are QueryStatsSummary (20 properties), ApiError (6 properties), QueryShapeResponse (5 properties), QueryShapeSeenMetadata (4 properties). Each schema is shown below with its type and property counts.

QueryShapeUpdateRequest
object
Request body for modifying the rejection status of a query shape.
1 property 1 required
ApiError
object
6 properties 2 required
Link
object
2 properties
QueryShapeResponse
object
Response containing the details and status of a query shape. The query shape field may be null if the user lacks PII view access.
5 properties 2 required
QueryShapeSeenMetadata
object
Metadata about when a query shape was seen.
4 properties
FieldViolation
object
2 properties 2 required
QueryStatsSummary
object
A summary of execution statistics for a given query shape.
20 properties
QueryStatsSummaryListResponse
object
1 property
QueryStatsDetailsResponse
object
Metadata and summary statistics for a given query shape.
3 properties
BadRequestDetail
object
Bad request detail.
1 property
PaginatedQueryShapes
object
Paginated collection of query shapes. This endpoint returns a maximum of 100 results.
3 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

mongodb-query-shape-insights-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 Query Shape Insights 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.