All APIs that return collections include the following properties:
- Count: The total number of items being returned in the collection.
- TotalMatchingFilter: The total number of items that match the filters specified on the query.
The only time that Count and TotalMatchingFilter differ is when the caller has specified take and/or skip parameters. When this happens, Count may be smaller than TotalMatchingFilter.
All APIs that return collections also have an equivalent API that can return the count of items in the collection. For example, the API to return tenants:
GET [apiRoot]/Tenants
has a related query for the total number of tenants:
GET [apiRoot]/Tenants/Count
The count APIs also process Filters. When a filter is specified, the result is the number of items which matches the specified filter(s). For example, to find the number of tenants with "acme" in their name:
GET [apiRoot]/Tenants/$count?name=*acme*