v3

latestOpenAPI 3.0.3MIT2026-07-313881,2455.6 MB
Database table grid view

Computes the aggregation of all the values for a specified field from the selected grid view. You must select the aggregation type by setting the type GET parameter. If filters are configured for the selected view, the aggregation is calculated only on filtered rows. You need to have read permissions on the view to request an aggregation.

get/api/database/views/grid/{view_id}/aggregation/{field_id}/

Path parameters

field_idinteger required

The field id you want to aggregate

view_idinteger required

Select the view you want the aggregation for.

Query parameters

includestring

if include is set to total, the total row count will be returned with the result.

typestring

The aggregation type you want. Available aggregation types: count, empty_count, not_empty_count, unique_count, min, max, sum, average, median, decile, variance, std_dev, distribution

Response

totalinteger

The total value count. Only returned if include=total is specified as GET parameter.

Example response

{
  "value": 5,
  "total": 7
}