MImixpeek
Collection Documents

Count documents in a collection.

Changed on

Return the total number of documents in the collection. This is the obvious REST endpoint for a document count; it is declared before the /{document_id} route so the literal count segment is never matched as a document id (which previously produced a misleading 404).

get/v1/collections/{collection_identifier}/documents/count

Request

Path parameters

collection_identifierstring required

The ID of the collection to count documents in.

Response

Successful Response

collection_idstring required

The collection the count is for (resolved id).

countinteger required

Total number of documents in the collection.

Changes

  • 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

  • 5d4c905106b4Revision changes
    • info

      the endpoint scheme security BearerAuth AND NamespaceHeader was added to the API