Skip to main content
GET
/
v1
/
analytics
/
namespaces
/
summary
Get Namespace Summary
curl --request GET \
  --url https://api.mixpeek.com/v1/analytics/namespaces/summary \
  --header 'Authorization: <authorization>' \
  --header 'X-Namespace: <x-namespace>'
{
  "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
    }
  ]
}

Headers

Authorization
string
required

REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings.

X-Namespace
string
required

REQUIRED: Namespace identifier for scoping this request. All resources (collections, buckets, taxonomies, etc.) are scoped to a namespace. You can provide either the namespace name or namespace ID. Format: ns_xxxxxxxxxxxxx (ID) or a custom name like 'my-namespace'

Query Parameters

days
integer
default:30

Days of history to analyze

Required range: 1 <= x <= 90

Response

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

most_queried_fields
FieldQueryMetrics · object[]
required

Most frequently queried fields

slowest_fields
FieldPerformanceMetrics · object[]
required

Fields with highest latency

compound_indexes
CompoundIndexPattern · object[]
required

Compound index opportunities