COUNT

The Count aggregate function allows you to calculate the number of objects in a table, optionally satisfying some criteria or grouped by values in a column. To use the function, include Count(columnNameInDatabase) into the list of properties requested from the server. For example, the following query retrieves the count of all movies in the database:

GET https://xxxx.backendless.app/api/data/Movie?props=Count(objectId) 

The query returns the following result, notice the count property in the returned object. The value of the property is the total count of all objects in the table:

[  
    {  
        "count": 8,  
        "___class": "Movie",  
    }  
]

Using Alias

To change the name of the returned property from count to a custom name, use the following syntax:

Count( columnNameInDatabase ) as customPropertyName

For example, the following query returns the total count value in the totalObjects property:

Important

The  value must be URL-encoded. The spaces are replaced with %20:

GET https://xxxx.backendless.app/api/data/Movie?props=Count(objectId)%20as%20totalObjects

The response for the query now contains the totalObjects property:

[  
    {  
        "totalObjects": 8,  
        "___class": "Movie",  
    }  
]

Grouping Results

Results in the response can be grouped by values from another column. To request grouping of the results, add the groupBy parameter to the request with the value containing the name of the column. For example, the following request returns the number of movies in the database grouped by the year the movies were released:

GET https://xxxx.backendless.app/api/data/Movie?props=Count(objectId),yearReleased&groupBy=yearReleased

The response for this request contains the number of the movies grouped by the release year:

[  
    {  
        "count": 1,  
        "yearReleased": 1997,  
        "___class": "Movie",  
    },  
    {  
        "count": 1,  
        "yearReleased": 2009,  
        "___class": "Movie",  
    },  
    {  
        "count": 1,  
        "yearReleased": 2011,  
        "___class": "Movie",  
    },  
    {  
        "count": 1,  
        "yearReleased": 2012,  
        "___class": "Movie",  
    },  
    {  
        "count": 4,  
        "yearReleased": 2015,  
        "___class": "Movie",  
    }  
]

Sorting

The results can be sorted using the sortBy parameter. For example, results for the following request will be sorted by the values in the yearReleased column in the descending order:

GET https://xxxx.backendless.app/api/data/Movie?props=Count(objectId),yearReleased&groupBy=yearReleased&sortBy=yearReleased%20DESC

To sort results by the aggregated value, assign a custom name to the column and sort by that name:

GET https://xxxx.backendless.app/api/data/Movie?props=Count(objectId)%20as%20movieCount,yearReleased&groupBy=yearReleased&sortBy=movieCount

Codeless Reference

Consider the following data table called Movie:

The example below counts the number of records stored in the movieName column. To calculate the number of records you must use the aggregate function Count(columnName) in the properties argument:

Important

For a detailed description of all input parameters see the Basic Object Retrieval topic of this guide.

After the Codeless logic runs the operation returns an object with the count property containing the number of records stored in the requested column/property:

Using Alias

Any default property returned in the response can have a custom name. You can change the default property name (e.g. count) returned in the response by defining a dynamic property as shown in the excerpt below. The movieName is the name of the column in the data table, and the numberOfMoviesInDatabase is the custom property name that will be shown in the response instead of the current property name (e.g. count):

Count(movieName) as numberOfMoviesInDatabase

The example below counts the number of values stored in the "movieName" column and returns the result with a custom property name "numberOfMoviesInDatabase":

After the Codeless logic runs, the operation returns an object with a new property name numberOfMoviesInDatabase:

Grouping The Results

Results can be grouped by values from another column. To group results you have to reference the name of the column in the group by property. By doing so, you instruct the operation to separate every counted value into a distinct object based on the value from the column you have used in the group by property.

As you reference the column name in the group by property, the operation groups all values first, and then it counts the total number.

The example below groups values in the movieName column/property by values in the yearReleased column/property into distinct objects and then counts the total. For better perception of the operation result you can also include the yearReleased in the properties argument, so that you could see the total number of movies for every year in the response.

The operation has returned a list of objects containing a total number of movies(movieName property) grouped by the values in the yearReleased column. As you can see, every object is separated by values from the yearReleased column.

Sorting

You can sort the data by referencing the column/property name in the sort by property.

Results for the following request will be sorted by the values in the yearReleased column in the descending order:

As you can see, objects returned in the response are sorted in descending order by values in the yearReleased column/property: