Skip to main content
GET
Get Namespace Stats

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, malformed, unknown, revoked, inactive or expired key returns 401; a key without the permission, scope or plan an operation needs returns 403.

Path Parameters

namespace_identifier
string
required

Either the namespace name or namespace ID

Examples:

"my_namespace"

"ns_1234567890"

Response

Successful Response

Per-namespace statistics (counts) returned by the stats endpoint.

namespace_id
string
required

Namespace identifier

document_count
integer
default:0

Total number of documents in this namespace. With document_count_complete false the count did not finish and this is a lower bound (the documents counted before it stopped, 0 when none were).

document_count_complete
boolean
default:true

Whether document_count finished. False when a collection's or the vector store's count timed out or failed, in which case document_count is a lower bound and a 0 does not mean the namespace is empty; ask again shortly.

bucket_count
integer
default:0

Total number of buckets in this namespace

collection_count
integer
default:0

Total number of collections in this namespace

object_count
integer
default:0

Total number of objects across all buckets in this namespace