---
title: "Get Collection Overview"
method: GET
path: "/v1/analytics/collections/{collection_id}/overview"
tags: ["Analytics", "Analytics - Collections"]
---

# Get Collection Overview

`GET /v1/analytics/collections/{collection_id}/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

## Path parameters

- `collection_id` string, required

## Response `200`

Successful Response

- CollectionOverviewResponse — 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
  - `documents_last_24h` integer, nullable — 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, nullable — 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, nullable — 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, nullable — 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).
  - `active_taxonomies` integer, required
  - `active_clusters` integer, required
  - `last_indexed` string, date-time, nullable — When the collection was last updated or indexed (collection updated_at). None when the collection record carries no update timestamp.

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `403` — Forbidden
- `404` — Not Found
- `422` — Validation Error
- `500` — Internal Server Error

## Changes

- **2026-08-24** `b40f559d564a` — 8 breaking
  - the response property `avg_processing_time_ms` became optional for the status `200`
  - the response property `documents_last_24h` became optional for the status `200`
  - the response property `documents_last_7d` became optional for the status `200`
  - the response property `success_rate` became optional for the status `200`
  - …4 more
- **2026-08-09** `5d4c905106b4` — 1 info
  - the endpoint scheme security `BearerAuth AND NamespaceHeader` was added to the API

[Change history](https://skmtc.dev/mixpeek/apis/mixpeek-api/changes/v1/analytics/collections/:collection_id/overview/get.md)

---

[API](https://skmtc.dev/mixpeek/apis/mixpeek-api.md) · [All operations](https://skmtc.dev/mixpeek/apis/mixpeek-api/llms.txt) · [OpenAPI document](https://skmtc.dev/mixpeek/apis/mixpeek-api/revisions/436f07a84cc9?raw)