Namespaces

Get Namespace Stats

Changed on

Returns document, bucket, collection, and object counts for a single namespace. Use this instead of relying on counts in the list endpoint.

get/v1/namespaces/{namespace_identifier}/stats

Request

  • Base URL: https://api.mixpeek.com
  • URL: https://api.mixpeek.com/v1/namespaces/{namespace_identifier}/stats
  • Auth: HTTP bearer

Path parameters

namespace_identifierstring required

Either the namespace name or namespace ID

Example:my_namespace

Response

Successful Response

namespace_idstring required

Namespace identifier

document_countinteger

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_completeboolean

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_countinteger

Total number of buckets in this namespace

collection_countinteger

Total number of collections in this namespace

object_countinteger

Total number of objects across all buckets in this namespace

Changes

  • 790bc16455f6Revision changes
    • info

      added the optional property to the response with the status

  • 61a175e8eb9aRevision 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