Get Namespace Summary

Get comprehensive namespace optimization summary.

Provides a complete overview of namespace performance including:

• Top index recommendations
• Most queried fields
• Slowest fields
• Compound index opportunities
• Summary statistics

Use Cases:

• Get full optimization picture
• Regular performance reviews
• Database health checks
• Planning optimization work

Response Includes:

• Summary statistics (field counts, priority levels)
• Top 10 index recommendations
• Top 10 most queried fields
• Top 10 slowest fields
• Top 10 compound index opportunities

Recommended Workflow:

1. Call this endpoint for overview
2. Use specific endpoints for details
3. Implement high-priority recommendations
4. Monitor improvement over time

Example:

curl -X GET "https://api.mixpeek.com/v1/analytics/namespaces/summary?days=30" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "X-Namespace: your-namespace"

GET /v1/analytics/namespaces/summary

Get Namespace Summary

cURL

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

200

{
  "namespace_id": "<string>",
  "time_range_days": 123,
  "summary": {},
  "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>"
    }
  ],
  "most_queried_fields": [
    {
      "field_name": "<string>",
      "query_count": 123,
      "avg_latency_ms": 123,
      "p95_latency_ms": 123
    }
  ],
  "slowest_fields": [
    {
      "field_name": "<string>",
      "usage_count": 123,
      "avg_latency_ms": 123,
      "p50_latency_ms": 123,
      "p95_latency_ms": 123,
      "p99_latency_ms": 123,
      "max_latency_ms": 123,
      "index_priority_score": 123
    }
  ],
  "compound_indexes": [
    {
      "field_combination": [
        "<string>"
      ],
      "combination_count": 123,
      "avg_latency_ms": 123,
      "p95_latency_ms": 123
    }
  ]
}

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

Response

200

application/json

Successful Response

Comprehensive namespace analytics summary.

namespace_id · string · required

Namespace ID analyzed

time_range_days · integer · required

Number of days analyzed

summary · Summary · object · required

Summary statistics (total_fields_analyzed, high_priority_indexes, etc.)

recommendations · IndexRecommendation · object[] · required

Top index recommendations

Show child attributes

most_queried_fields · FieldQueryMetrics · object[] · required

Most frequently queried fields

Show child attributes

slowest_fields · FieldPerformanceMetrics · object[] · required

Fields with highest latency

Show child attributes

compound_indexes · CompoundIndexPattern · object[] · required

Compound index opportunities

Show child attributes