---
title: Filter
framework: Apple Ads Platform API
role: symbol
role_heading: Object
platforms: [apple ads platform api 1.0+]
path: apple-ads-platform-api/filter
---

# Filter

Filter condition for reporting requests.

## Declaration

```data
object Filter
```

## Properties

field: The name of the field to filter on (for example, localSpend, impressions). operator: Comparison operator. Supported operators (may vary by endpoint): BETWEEN, CONTAINS, CONTAINS_ANY, CONTAINS_ALL, ENDS_WITH, EQUALS, GREATER_THAN, GREATER_THAN_OR_EQUAL_TO, IN, LESS_THAN, LESS_THAN_OR_EQUAL_TO, LIKE, NOT_EQUALS, STARTS_WITH. value: One or more filter conditions applied to the result set.

## Discussion

Discussion The Filter specifies a single field-level filter condition for a reporting request. The field name must match a filterable field on the target entity (for example, localSpend, impressions, campaignId). The operator determines the comparison type, and value supplies the comparison operand. You can include multiple Filter objects in the filters array of a AppsReportingRequest or BrandsReportingRequest to narrow results by several criteria simultaneously. Supported operators vary by endpoint and field type: numeric fields support range operators like GREATER_THAN and BETWEEN. String fields support EQUALS, IN, and pattern operators like STARTS_WITH. Endpoints that accept a Filter are: Campaigns Report, Ad Groups Report, Ads Report, Keywords Report, Search Terms Report, Campaigns Report (Brands), Ad Groups Report (Brands), Ads Report (Brands), Keywords Report (Brands), Search Terms Report (Brands), Impression Share Query, and Search Term Popularity Query. Example {   "field": "localSpend",   "operator": "GREATER_THAN",   "value": [     "100.00"   ] }

## Topics

### Dictionaries

- [Filter.Value](apple-ads-platform-api/filter/value-data.dictionary.md)

## See Also

- [TimeRange](apple-ads-platform-api/timerange.md)
- [Sorting](apple-ads-platform-api/sorting.md)
- [RequestPagination](apple-ads-platform-api/requestpagination.md)
- [ReportingMoney](apple-ads-platform-api/reportingmoney.md)
- [ReportingBidStrategy](apple-ads-platform-api/reportingbidstrategy.md)
- [ReportingCampaignMin](apple-ads-platform-api/reportingcampaignmin.md)
- [ReportingAdGroupMin](apple-ads-platform-api/reportingadgroupmin.md)
- [ReportingCreativeSpec](apple-ads-platform-api/reportingcreativespec.md)
- [ReportingDestination](apple-ads-platform-api/reportingdestination.md)
- [ReportingKeyword](apple-ads-platform-api/reportingkeyword.md)
- [ReportingSearchTerm](apple-ads-platform-api/reportingsearchterm.md)
- [ActionMetrics](apple-ads-platform-api/actionmetrics.md)
- [CostMetrics](apple-ads-platform-api/costmetrics.md)
- [RateMetrics](apple-ads-platform-api/ratemetrics.md)
- [ReportingAdChannelType](apple-ads-platform-api/reportingadchanneltype.md)