- API >
- Public API Resources >
- Measurements and Alerts >
- Performance Advisor >
- Get Suggested Indexes
Get Suggested Indexes¶
On this page
Retrieves suggested indexes as determined by the Performance Advisor.
Base URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
Resource¶
Request Path Parameters¶
Parameter | Type | Description |
---|---|---|
GROUP-ID | string | (Required.) Unique identifier of the group that owns this MongoDB process. |
HOST-ID | string | (Required.) Unique identifier of the host for the MongoDB process. |
Request Query Parameters¶
All parameters are optional.
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 |
since | long | Point in time from which to retrieve suggested indexes, stated in milliseconds since epoch. | previous 24 hours |
duration | long | Length of time in milliseconds during which to find suggested indexes among the managed namespaces in the cluster. | up to the present time |
namespaces | string | Namespaces from which to retrieve suggested indexes. A namespace
consists of the database and collection resource separated by a
To specify multiple namespaces, pass the parameter multiple times
using an ampersand ( Example ?namespaces=data.stocks&namespaces=data.zips&pretty=true |
all |
nIndexes | long | Maximum number of indexes to suggest. | unlimited |
nExamples | long | Maximum number of examples queries to provide that will be improved by a suggested index. | 5 |
Request Body Parameters¶
This endpoint does not use HTTP request body parameters.
Response¶
Name | Type | Description |
---|---|---|
shapes | array of documents | Documents with information about the query shapes that are served by the suggested indexes. |
shapes[n].avgMs | long | Average duration in milliseconds for the queries examined that match this shape. |
shapes[n].count | long | The number of queries examined that match this shape. |
shapes[n].id | objectId | Unique id for this shape. Exists only for the duration of the API request. |
shapes[n].inefficiencyScore | long | The average number of documents read for every document returned by the query. For more information, see Understanding the Query Inefficiency Score. |
shapes[n].namespace | string | The namespace searched by the queries in this shape. |
shapes[n].operations | array of documents | Documents with specific information and log lines for individual queries. |
shapes[n].operations[n].predicates | array of documents | Documents containing the search criteria used by the query. Values in key-value pairs will be redacted in these predicates unless the user has Project Data Access Read Only permissions or higher. |
shapes[n].operations[n].raw | string | The raw log line produced by the query. Note This information is redacted for users who do not have the necessary access permissions. |
shapes[n].operations[n].stats | document | Query statistics. |
shapes[n].operations[n].stats.ms | long | Duration in milliseconds of the query. |
shapes[n].operations[n].stats.nReturned | long | Number of results returned by the query. |
shapes[n].stats.nScanned | long | Number of documents read by the query. |
shapes[n].stats.ts | long | Query timestamp, in seconds since epoch. |
suggestedIndexes | array of documents | Documents with information about the indexes suggested by the Performance Advisor. |
suggestedIndexes[n].id | objectId | Unique id for this suggested index. |
suggestedIndexes[n].impact | array of objectIds | A list of objectIds which identify the shapes in this response which pertain to this suggested index. |
suggestedIndexes[n].index | array of documents | Each array element is a document that specifies a key in the index and its sort order, ascending or descending.
Keys in indexes with multiple keys appear in the same order that they appear in the index. |
suggestedIndexes[n].index.<fieldname> | string | The specific field to be indexed. |
suggestedIndexes[n].namespace | string | The namespace of the suggested index. |