Skip to main content
GET
/
v1
/
analytics
/
collections
/
{collection_id}
/
overview
Get Collection Overview
curl --request GET \
  --url https://api.mixpeek.com/v1/analytics/collections/{collection_id}/overview
{
  "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"
}

Headers

​
Authorization
string

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: 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'

Path Parameters

​
collection_id
string
required

Response

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