List entries / List_ only aggregates
Returns unique values to be used in filter input. Max 1000 rows.
Route: /api/{tenant:minlength(2)}/v{version:apiVersion}/list_entries/{list_id}/aggregate
Method: GET
Authorisation: Minimum role: USER
Request Arguments
| Name | Type | Source |
|---|---|---|
| list_id | Int32 | |
| field_keys | String[] | Query |
| filter | DTO_standard_filter | Query |
Request body example
Response object
Response status: 200 (OK)
Response type: Object[]
Wrapper: DTO_response_wrap_get_many
Other response statuses: 400 (BadRequest), 403 (Forbidden)
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 |
