Collections

Get number of documents in a collection

Retrieve the count of documents within the collection.

Note: This always loads the collection into memory.

get/_fabric/{fabric}/_api/collection/{collection-name}/count

Request

The document declares no server URL.
Auth
- API key in header Authorization
- or HTTP bearer
TypeScript
https://skmtc.dev/macrometa/apis/macrometa-api-reference/docs/_fabric/:fabric/_api/collection/:collection-name/count/get.ts
A function with typed inputs. Its response is checked against the schema.

fabricstring string required

The name of the fabric.

collection-namestring string required

The name of the collection.

Successfully fetched number of documents in a collection.

codeinteger

HTTP response code.

errorboolean

Flag if there is an error in response. False for this response.

searchEnabledboolean

True if collection is searchable.

countstring

Number of document in the collection.

idstring

Id of the the collection.

isSystemboolean

True if collection is a system collection.

namestring

Name of the collection.

globallyUniqueIdstring

Global unique identifier.

{
  "code": 200,
  "count": "89218",
  "id": "89218",
  "name": "colltest0127133421258ogefv",
  "globallyUniqueId": "h83A7584E8AA9"
}

No recorded changes to this operation across all 1 revision of this API.