Count docs with Legacy QL
Count the number of documents in a collection that match a specified query. This endpoint is useful for pagination, analytics, and understanding the size of your dataset.
Authorizations
Authentication using either an API key or JWT token in the Authorization header
Headers
Optional transaction ID header that ensures consistency. If specified, the operation will only proceed if the Big Peer's transaction ID is equal to or greater than this value. This prevents reading stale data by ensuring you're operating on a sufficiently up-to-date version of the database.
Body
Request parameters for counting documents in a collection. Use this to get the total number of documents matching specific criteria.
The name of the collection to count documents in
A query expression that filters which documents to count. Use parameterized values with :param syntax for better security and performance
Optional parameters to use in the parameterized query, providing safe value substitution
Response
Response from a count operation, providing both the count and transaction ID for consistency tracking.
The total number of documents that matched the query criteria
The transaction ID at which this count was performed, useful for consistency checks
Was this page helpful?