Skip to main content
GET
/
v1
/
analytics
/
indexes
/
suggestions
Get Index Suggestions
curl --request GET \
  --url https://api.mixpeek.com/v1/analytics/indexes/suggestions \
  --header 'Authorization: <authorization>' \
  --header 'X-Namespace: <x-namespace>'
{
  "namespace_id": "<string>",
  "analysis_period": "<string>",
  "suggestions": [
    {
      "field_name": "<string>",
      "query_count_24h": 123,
      "suggested_type": "<string>",
      "is_indexed": true,
      "first_seen": "2023-11-07T05:31:56Z",
      "last_seen": "2023-11-07T05:31:56Z",
      "query_count_7d": 123,
      "estimated_performance_gain": "<string>"
    }
  ],
  "auto_create_enabled": true,
  "next_auto_create_run": "2023-11-07T05:31:56Z"
}

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

​
hours
integer
default:24

Time window in hours to analyze (max 30 days)

Required range: 1 <= x <= 720
​
min_count
integer
default:100

Minimum query count threshold for suggestions

Required range: 1 <= x <= 10000

Response

Successful Response

Response containing index suggestions for a namespace.

​
namespace_id
string
required

Namespace being analyzed

​
analysis_period
string
required

Time period analyzed (e.g., '24h', '7d')

​
suggestions
IndexSuggestion · object[]
required

List of index suggestions

​
auto_create_enabled
boolean
required

Whether auto-indexing is enabled for this namespace

​
next_auto_create_run
string<date-time> | null

Next scheduled auto-creation run (if enabled)