atlas api performanceAdvisor listSuggestedIndexes

int

false

Length of time expressed during which the query finds suggested indexes among the managed namespaces in the cluster. This parameter expresses its value in milliseconds.

• If you don't specify the since parameter, the endpoint returns data covering the duration before the current time.

• If you specify neither the duration nor since parameters, the endpoint returns data from the previous 24 hours.

envelope

false

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.

string

true

Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) 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.

false

help for listSuggestedIndexes

false

Flag that indicates whether the response returns the total number of items (totalCount) in the response.

int

false

Number of items that the response returns per page.

int

false

Maximum number of example queries that benefit from the suggested index.

int

false

Number that indicates the maximum indexes to suggest.

.

false

Namespaces from which to retrieve suggested indexes. A namespace consists of one database and one collection resource written as .: <database>.<collection>. To include multiple namespaces, pass the parameter multiple times delimited with an ampersand (&) between each namespace. Omit this parameter to return results for all namespaces.

string

false

preferred api format, can be ["json", go-template] This value defaults to "json".

string

false

file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip)

int

false

Number of the page that displays the current set of the total objects that the response returns.

false

Flag that indicates whether the response body should be in the prettyprint format.

mongod

true

Combination of host and port that serves the MongoDB process. The host must be the hostname, FQDN, IPv4 address, or IPv6 address 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.

int

false

Date and time from which the query retrieves the suggested indexes. This parameter expresses its value in the number of milliseconds that have elapsed since the [UNIX epoch](https://en.wikipedia.org/wiki/Unix_time).

• If you don't specify the duration parameter, the endpoint returns data covering from the since value and the current time.

• If you specify neither the duration nor the since parameters, the endpoint returns data from the previous 24 hours.

string

false

api version to use when calling the api call [options: "2023-01-01"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2023-01-01".