Skip to main content
GET
Get Collection Overview

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

Successful Response

Collection overview metrics.

Honesty contract: every field is computed from a real source. A field whose source is not reachable from the analytics service is Optional and returned as None, meaning "not yet computed here", never a fabricated 0 or 1.0.

collection_id
string
required
collection_name
string
required
total_documents
integer
required
active_taxonomies
integer
required
active_clusters
integer
required
documents_last_24h
integer | null

Documents created in the last 24h. None means NOT YET COMPUTED here, which is different from zero: no faithful per-window document-created count is reachable from this service. A created_at range filter on the vector store silently matches nothing (the shard range compares numerics and created_at is an ISO-8601 string), and the ClickHouse growth series counts distinct source objects rather than documents created.

documents_last_7d
integer | null

Documents created in the last 7d. None means NOT YET COMPUTED here, which is different from zero; see documents_last_24h for why no faithful source is wired.

avg_processing_time_ms
number | null

Mean extraction latency (ms) over the recent window, from ClickHouse. None means NOT YET COMPUTED here, which is different from zero: the window held no timed events, or the analytics store was unavailable.

success_rate
number | null

Object to document conservation ratio (produced object count / source object count) from reconciliation. None means NOT YET COMPUTED here, which is different from 1.0: the collection has no source objects to conserve (a non-bucket source, or nothing ingested yet).

last_indexed
string<date-time> | null

When the collection was last updated or indexed (collection updated_at). None when the collection record carries no update timestamp.