Analytics
Analytics - Collections

Get Collection Overview

Changed on

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

Request

  • Base URL
    https://api.mixpeek.com
  • Auth
    HTTP bearer and API key in header X-Namespace

Path parameters

collection_idstring required

Response

Successful Response

collection_idstring required
collection_namestring required
total_documentsinteger required
documents_last_24hinteger 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 analytics growth series counts distinct source objects rather than documents created.

documents_last_7dinteger 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_msnumber nullable

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

success_ratenumber 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_taxonomiesinteger required
active_clustersinteger required
last_indexedstring date-time nullable

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

Changes

    • warning

      removed the optional property from the response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the optional property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • breaking

      the response property became optional for the status

    • breaking

      the response property became optional for the status

    • breaking

      the response property became optional for the status

    • breaking

      the response property became optional for the status

    • breaking

      response property avg_processing_time_ms list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property documents_last_24h list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property documents_last_7d list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property success_rate list-of-types was widened by adding types null to media type application/json of response 200