GET /api/database/views/grid/{slug}/public/group-by-data/

The public grid view slug.

A JSON serialized string containing the filter tree to apply to this view. The filter tree is a nested structure containing the filters that need to be applied.

An example of a valid filter tree is the following:{"filter_type": "AND", "filters": [{"field": 1, "type": "equal", "value": "test"}]}. The field value must be the ID of the field to filter on, or the name of the field if user_field_names is true.

The following filters are available: equal, not_equal, filename_contains, files_lower_than, has_file_type, contains, contains_not, contains_word, doesnt_contain_word, starts_with, length_is_lower_than, higher_than, higher_than_or_equal, lower_than, lower_than_or_equal, is_even_and_whole, date_equal, date_before, date_before_or_equal, date_after_days_ago, date_after, date_after_or_equal, date_not_equal, date_equals_today, date_before_today, date_after_today, date_within_days, date_within_weeks, date_within_months, date_equals_days_ago, date_equals_months_ago, date_equals_years_ago, date_equals_week, date_equals_month, date_equals_day_of_month, date_equals_year, date_is, date_is_not, date_is_before, date_is_on_or_before, date_is_after, date_is_on_or_after, date_is_within, single_select_equal, single_select_not_equal, single_select_is_any_of, single_select_is_none_of, link_row_has, link_row_has_not, link_row_contains, link_row_not_contains, boolean, empty, not_empty, multiple_select_has, multiple_select_has_not, multiple_collaborators_has, multiple_collaborators_has_not, user_is, user_is_not, has_value_equal, has_not_value_equal, has_value_contains, has_not_value_contains, has_value_contains_word, has_not_value_contains_word, has_value_length_is_lower_than, has_all_values_equal, has_empty_value, has_not_empty_value, has_any_select_option_equal, has_none_select_option_equal, has_value_lower, has_value_lower_or_equal, has_value_higher, has_value_higher_or_equal, has_not_value_higher_or_equal, has_not_value_higher, has_not_value_lower_or_equal, has_not_value_lower, has_date_equal, has_not_date_equal, has_date_before, has_not_date_before, has_date_on_or_before, has_not_date_on_or_before, has_date_on_or_after, has_not_date_on_or_after, has_date_after, has_not_date_after, has_date_within, has_not_date_within.

Please note that if this parameter is provided, all other filter__{field}__{filter} will be ignored, as well as the filter_type parameter.

AND: Indicates that the rows must match all the provided filters.

OR: Indicates that the rows only have to match one of the filters.

This works only if two or more filters are provided.

Please note that if the filters parameter is provided, this parameter will be ignored.

Optionally the groups can be built from the provided field ids separated by comma instead of the view's own group-bys. This allows visitors of the publicly shared view to group ad hoc.

If provided only rows with data that matches the search query are going to be returned.

Optional zero-based group-by depth. When provided, the endpoint returns one global page of groups at that depth, capped by limit, and splits the returned groups into their parent pages.

Optional JSON array of parent page requests. Each item can be a group path object, or an object with parent, offset, and limit. When omitted, top-level groups are returned.

Optional per-descendant-page group limit. Defaults to the request limit and is capped by the row page size limit and the total group budget.

The rows can optionally be filtered by the same view filters available for the views. Multiple filters can be provided if they follow the same format. The field and filter variable indicate how to filter and the value indicates where to filter on.

For example if you provide the following GET parameter filter__field_1__equal=test then only rows where the value of field_1 is equal to test are going to be returned.

The following filters are available: equal, not_equal, filename_contains, files_lower_than, has_file_type, contains, contains_not, contains_word, doesnt_contain_word, starts_with, length_is_lower_than, higher_than, higher_than_or_equal, lower_than, lower_than_or_equal, is_even_and_whole, date_equal, date_before, date_before_or_equal, date_after_days_ago, date_after, date_after_or_equal, date_not_equal, date_equals_today, date_before_today, date_after_today, date_within_days, date_within_weeks, date_within_months, date_equals_days_ago, date_equals_months_ago, date_equals_years_ago, date_equals_week, date_equals_month, date_equals_day_of_month, date_equals_year, date_is, date_is_not, date_is_before, date_is_on_or_before, date_is_after, date_is_on_or_after, date_is_within, single_select_equal, single_select_not_equal, single_select_is_any_of, single_select_is_none_of, link_row_has, link_row_has_not, link_row_contains, link_row_not_contains, boolean, empty, not_empty, multiple_select_has, multiple_select_has_not, multiple_collaborators_has, multiple_collaborators_has_not, user_is, user_is_not, has_value_equal, has_not_value_equal, has_value_contains, has_not_value_contains, has_value_contains_word, has_not_value_contains_word, has_value_length_is_lower_than, has_all_values_equal, has_empty_value, has_not_empty_value, has_any_select_option_equal, has_none_select_option_equal, has_value_lower, has_value_lower_or_equal, has_value_higher, has_value_higher_or_equal, has_not_value_higher_or_equal, has_not_value_higher, has_not_value_lower_or_equal, has_not_value_lower, has_date_equal, has_not_date_equal, has_date_before, has_not_date_before, has_date_on_or_before, has_not_date_on_or_before, has_date_on_or_after, has_not_date_on_or_after, has_date_after, has_not_date_after, has_date_within, has_not_date_within.

Please note that if the filters parameter is provided, this parameter will be ignored.

When true, returns a lean values-only page: each group carries only its path (plus children_count and per-group aggregations) and omits the windowed layout fields (row_count, sibling_index, row_offset). Used to refresh aggregation values in place without rebuilding the layout.

When true, the response also includes a top-level aggregations object with the view's table-level field aggregation totals, mirroring the grid view field-aggregations response.

If provided, allows API consumers to determine what kind of search experience they wish to have. If the default SearchMode.FT_WITH_COUNT is used, then Postgres full-text search is used. If SearchMode.COMPAT is provided then the search term will be exactly searched for including whitespace on each cell. This is the Baserow legacy search behaviour.

When true, each returned group page also preloads bounded descendant pages starting at offset 0. The walk is bounded by descendant page and leaf-row budgets plus server-side caps.

Optional total leaf-row budget for include_descendants. Defaults to the request limit and is capped by the total group budget.