Get Collection Overview

Get high-level collection health and status metrics.

Provides collection health including:

• Total document count and recent growth
• Processing performance and success rates
• Active enrichments (taxonomies, clusters)

Use Cases:

• Monitor collection health
• Quick status check
• Identify collections needing attention

GET /v1/analytics/collections/{collection_id}/overview

Get Collection Overview

cURL

curl --request GET \
  --url https://api.mixpeek.com/v1/analytics/collections/{collection_id}/overview \
  --header 'Authorization: Bearer <token>' \
  --header 'X-Namespace: <api-key>'

200

{
  "collection_id": "<string>",
  "collection_name": "<string>",
  "total_documents": 123,
  "documents_last_24h": 123,
  "documents_last_7d": 123,
  "avg_processing_time_ms": 123,
  "success_rate": 123,
  "active_taxonomies": 123,
  "active_clusters": 123,
  "last_indexed": "2023-11-07T05:31:56Z"
}

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.

Path Parameters

collection_id · string · required

Response

200

application/json

Successful Response

Collection overview metrics.

collection_id · string · required

collection_name · string · required

total_documents · integer · required

documents_last_24h · integer · required

documents_last_7d · integer · required

avg_processing_time_ms · number · required

success_rate · number · required

active_taxonomies · integer · required

active_clusters · integer · required

last_indexed · string<date-time> | null