Skip to content

Commit a3c7d1f

Browse files
authored
Merge pull request #2230 from segmentio/DOC-381
Clarify format required for Filtering Array Properties [DOC-381]
2 parents 0f1ed15 + 4aab43a commit a3c7d1f

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

src/connections/destinations/destination-filters.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -119,7 +119,11 @@ Errors aren't exposed in the Event Deliverability tab of your Destination. For h
119119
**Q: How does destination filters work with array properties?**
120120

121121
Destination Filters can filter properties out of objects nested in an array. For
122-
example, you could filter out the `price` property of every object in an array at `properties.products`. You can also filter out an entire array from the payload. However, you can't drop nested objects in an array, or filter properties out of a single object in an array.
122+
example, you can filter out the `price` property of every object in an array at `properties.products`. You can also filter out an entire array from the payload. However, you can't drop nested objects in an array, or filter properties out of a single object in an array.
123+
124+
In order to block a specific property from all of the objects within a properties array, set the filter following the format: `<propertyType>.<arrayName>.<arrayElementLabel>​`.
125+
126+
For example, the `properties.products.product_id` filter blocks all `product_id` fields from every `products` object in an array with the `properties` object. If you want to block the Identify trait product_id, select the filter under the User Traits option instead. You can also select from the Context Fields section for context object scenarios.
123127

124128
**Q: How many filters can I create?**
125129

0 commit comments

Comments
 (0)