Skip to content

Get Object Count

The Object Count API provides a way to obtain the following values from the server:

  • Number of objects in a table
  • Number of objects matching query
  • Number of related objects

Method:

GET

Endpoint URL

The xxxx.backendless.app is a subdomain assigned to your application. For more information see the Client-side Setup section of this documentation.

https://xxxx.backendless.app/api/data/<table-name>/count?where=<whereClause>

where:

Argument                Description
<table-name> name of the table to get an object count from.
<whereClause> Optional argument. If set, it is a search query used by the server it to determine the number of objects matching the condition. The value must be URL-encoded.

Request Headers

user-token:value-of-the-user-token-header-from-login

where:

Argument                Description
user-token Optional header. Contains a value returned by Backendless in a preceding user Login API call. If user-tokenis set in the request, the operation will be executed with the security policy associated with the currently logged in user. This means all permissions associated with the user and roles assigned to the user will be enforced by Backendless.

Request Body

None

Response Body:

The number of objects in a table (if the whereClause is not set), otherwise the number of objects matching the search query.

Example

Important

Make sure to replace xxxx in the domain name in the sample requests below to the one assigned to your application.

Total object count for a table:

The following sample request retrieves total number of objects in table Order:

curl "https://xxxx.backendless.app/api/data/Order/count"

Object count for a query:

The following sample request retrieves total number of objects in table Order which satisfy the condition of orderAmount > 100:

curl "https://xxxx.backendless.app/api/data/Order/count?where=orderAmount%20%3E%20100"

Related object count:

The following sample request retrieves total number of related "child" objects for a parent object. The parent table is Person. It contains a relation column called address pointing to the Addresstable. The query below retrieves a count of related child objects for a parent object with objectID of XXXX-XXXX-XXXX-XXXX. The whereClause query syntax for this scenario is:

Person[address].objectId = 'XXXX-XXXX-XXXX-XXXX'

The whereClause must be URL-encoded, which results in the following sample request:

curl "https://xxxx.backendless.app/api/data/Address/count?where=Person%5Baddress%5D.objectId%20%3D%20%27XXXX-XXXX-XXXX-XXXX%27"