Get Index Recommendations

Get comprehensive MongoDB index recommendations.

Analyzes query patterns and generates prioritized index recommendations with ready-to-use MongoDB commands.

Use Cases:

• Get actionable index suggestions
• Prioritize database optimization
• Copy/paste index creation commands
• Track optimization opportunities

Recommendation Levels:

• HIGH PRIORITY: >100 queries, >300ms avg OR >10 very slow queries
• MEDIUM PRIORITY: >50 queries, >200ms avg OR >20 slow queries
• LOW PRIORITY: >10 queries but acceptable performance
• NO ACTION: Low usage, no optimization needed

Response Includes:

• Prioritized recommendations
• Usage and latency statistics
• MongoDB index creation commands
• Summary by priority level

Example:

curl -X GET "https://api.mixpeek.com/v1/analytics/namespaces/indexes/recommendations" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "X-Namespace: your-namespace"

GET /v1/analytics/namespaces/indexes/recommendations

Get Index Recommendations

cURL

curl --request GET \
  --url https://api.mixpeek.com/v1/analytics/namespaces/indexes/recommendations \
  --header 'Authorization: Bearer <token>' \
  --header 'X-Namespace: <api-key>'

200

{
  "namespace_id": "<string>",
  "time_range_days": 123,
  "recommendations": [
    {
      "field_name": "<string>",
      "query_count": 123,
      "avg_latency_ms": 123,
      "p95_latency_ms": 123,
      "slow_query_count": 123,
      "very_slow_query_count": 123,
      "priority_score": 123,
      "recommendation": "<string>",
      "mongodb_index_command": "<string>"
    }
  ],
  "summary": {}
}

Authorizations

Authorization · string · header · required

Mixpeek API key, sent as Authorization: Bearer mxp_sk_.... Create one in Studio under Settings → API Keys, or with an admin key via POST /v1/organizations/users/{user_email}/api-keys. A missing header returns 403; an invalid or revoked key returns 401.

X-Namespace · string · header · required

Namespace id (ns_...), not the namespace name. This scopes the request rather than authenticating it, and it is required on every operation marked x-mixpeek-namespace-scoped.

Query Parameters

days · integer · default: 30

Days of history to analyze

Required range: 1 <= x <= 90

min_usage_count · integer · default: 5

Minimum queries to consider

Required range: 1 <= x <= 100

limit · integer · default: 50

Maximum recommendations to return

Required range: 1 <= x <= 100

Response

200

application/json

Successful Response

Response for index recommendations endpoint.

namespace_id · string · required

Namespace ID analyzed

time_range_days · integer · required

Number of days analyzed

recommendations · IndexRecommendation · object[] · required

Index recommendations

Show child attributes

summary · Summary · object · required

Summary statistics (high_priority, medium_priority, low_priority counts)

Show child attributes