---
id: v1-filter-aggregation
title: FilterAggregation
pagination_label: FilterAggregation
sidebar_label: FilterAggregation
sidebar_class_name: typescriptsdk
keywords: ['typescript', 'TypeScript', 'sdk', 'FilterAggregation', 'v1FilterAggregation']
slug: /tools/sdk/typescript/search/models/filter-aggregation
tags: ['SDK', 'Software Development Kit', 'FilterAggregation', 'v1FilterAggregation']
---

# FilterAggregation

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | `string` | The name of the filter aggregate to be included in the result. | [default to undefined]
**type** | **(optional)** `SearchFilterType` |  | [default to undefined]
**field** | `string` | The search field to apply the filter to.  Prefix the field name with \'@\' to reference a nested object.  | [default to undefined]
**value** | `string` | The value to filter on. | [default to undefined]