/Reports/:record/record_count GET
Overview
An API to get total number of filtered records from a saved report.
Summary
This endpoint will return total number of records from a saved report filtered by an expression.
Request Arguments
| Name |
Type |
Description |
Required |
|---|
|
group_filters
|
String
|
The group filter expression. Filter expressions are explained below.
Note that JSON-encoded filters can be specified as query parameters
in one of two ways for GET requests:
-
By specifying individual filter arguments as distinct parameters.
Example:
group_filters[0][name]=value.
-
By specifying the whole filter as a single JSON-encoded string.
Example:
group_filters=[{"name":"value"}].
Example: group_filters[0][industry]=Engineering.
|
False
|
|
use_saved_filters
|
Boolean
|
Flag to indicate whether or not to apply saved runtime filters if exists. The default value is false.
Example: use_saved_filters=true.
|
False
|
Request Example
GET /rest/v10/Reports/:id/record_count?group_filters[0][industry]=Engineering
Response Arguments
| Name |
Type |
Description |
|---|
|
record_count
|
Integer
|
Total number of filtered records.
|
Response
{
"record_count": 5
}