List entries
List_ only aggregates
Returns the distinct values, with hit counts, that the given field_keys take across the list, for populating filter inputs; take, page and the sort arguments in the filter are ignored because no entries come back alongside them. The 1000 row cap applies per field key rather than to the call as a whole, and when a filter is applied the value list is still the unfiltered one, with the filtered count reported next to the overall count.
GET
/api/{tenant:minlength(2)}/v{version:apiVersion}/list_entries/{list_id}/aggregate
Request arguments
| Name | Type | Source |
|---|---|---|
| list_id | Int32 | |
| field_keys | String[] | Query |
| filter | DTO_standard_filter | Query |
Request body example
Response
Response body example
DTO_standard_filter
| Name | Type | ReadOnly | Description |
|---|---|---|---|
| sort_by_key | String | Sort by key | |
| response_field_keys | String[] | Only return the fields specified | |
| filters | String[] | Each string needs to be structured: filters=field_key:operator:value1|value2|value3 Only used to store filters for passing along as querystring | |
| include_aggregations | Boolean | Include aggregations | |
| include_imported | Boolean | Include imported | |
| search | String | Search | |
| sort_order | ENUM sort_order | Sort order | |
| take | Int32 | Take | |
| page | Int32 | Page |
ENUM sort_order
| Value | Name | Description |
|---|---|---|
| 0 | ASC | ASC |
| 1 | DESC | DESC |
Generated Aug 4, 2026 18:37