Skip to content

Commit 7212035

Browse files
committed
[netlify-build]
1 parent 4c2d86c commit 7212035

File tree

1 file changed

+20
-19
lines changed

1 file changed

+20
-19
lines changed

src/connections/destinations/destination-filters.md

Lines changed: 20 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -20,20 +20,21 @@ Common use cases for destination filters include:
2020

2121
### Limitations
2222

23-
Keep the following limitations in mind when you use Destination Filters:
23+
Keep the following limitations in mind when you use destination filters:
2424

25-
- Segment applies Destination Filters one at a time in the order that they appear in your workspace.
26-
- You can't apply Destination Filters to Warehouses or S3 destinations.
25+
- Segment applies destination filters one at a time in the order that they appear in your workspace.
26+
- You can't apply destination filters to Warehouses or S3 destinations.
2727
- Each filter can only apply to one source-destination pair.
2828
- *(For device-mode)* Destination filters don't apply to items that are added to the payload server-side such as IP addresses.
2929
- *(For device-mode)* Destination filters don't filter on native events that the destination SDK collects. Instead, you can use the load option to conditionally load relevant bundled JavaScript on the page. See the docs for [load options](/docs/connections/sources/catalog/libraries/website/javascript/#load-options).
30+
- *(For device-mode)* Destination filters don't filter some fields that are collected by the destination SDK outside of Segment such as `page.url` and `page.referrer`.
3031
- *(For web device-mode)* Destination filters for web device-mode only supports the Analytics.js 2.0 source. You need to enable device mode destination filters for your Analytics.js source. To do this, go to your Javascript source and navigate to **Settings > Analytics.js** and turn the toggle on for **Destination Filters**.
3132

3233
[Contact Segment](https://segment.com/help/contact/){:target="_blank"} if these limitations impact your use case.
3334

3435
## Create a destination filter
3536

36-
To create a Destination Filter:
37+
To create a destination filter:
3738
1. Go to **Connections > Destinations** and select your destination.
3839
2. Click on the **Filters** tab of your destination.
3940
3. Click **+ New Filter**.
@@ -45,9 +46,9 @@ To create a Destination Filter:
4546

4647
## Destination filters API
4748

48-
The Destination Filters API provides more power than Segment's dashboard Destination Filters settings. With the API, you can create complex filters that are conditionally applied using Segment's [Filter Query Language (FQL)](/docs/api/config-api/fql/).
49+
The destination filters API provides more power than Segment's dashboard destination filters settings. With the API, you can create complex filters that are conditionally applied using Segment's [Filter Query Language (FQL)](/docs/api/config-api/fql/).
4950

50-
The Destination Filters API offers four different filter types:
51+
The destination filters API offers four different filter types:
5152

5253
| Filter | Details |
5354
| ------------------ | ------------------------------------------------------------ |
@@ -60,7 +61,7 @@ To learn more, read Segment's [Destination Filters API docs](https://docs.segmen
6061

6162
## Examples
6263

63-
The following examples illustrate common Destinations Filters use cases:
64+
The following examples illustrate common destinations filters use cases:
6465
* [PII management](#pii-management)
6566
* [Control event volume](#control-event-volume)
6667
* [Cleaner data](#cleaner-data)
@@ -72,7 +73,7 @@ The following examples illustrate common Destinations Filters use cases:
7273

7374
Example: Remove email addresses from `context` and `properties`:
7475

75-
Property-level allowlisting is available with Segment's API. Using Destination Filters, you can configure a rule that removes email addresses from `context` and `properties`. As a result, Segment only sends traits without PII to the destination.
76+
Property-level allowlisting is available with Segment's API. Using destination filters, you can configure a rule that removes email addresses from `context` and `properties`. As a result, Segment only sends traits without PII to the destination.
7677

7778

7879
![PII management example](images/destination-filters/pii_example.png)
@@ -101,31 +102,31 @@ In the example below, the rule prevents an event from sending if `Order Complete
101102

102103
### Sample a percentage of events
103104

104-
Using the [Destination Filters API](https://docs.segmentapis.com/tag/Destination-Filters){:target="_blank"}, you can create a rule to randomly sample video heartbeat events.
105+
Using the [destination filters API](https://docs.segmentapis.com/tag/Destination-Filters){:target="_blank"}, you can create a rule to randomly sample video heartbeat events.
105106

106107
### Drop events
107108

108-
[Watch this Destination Filters walkthrough](https://www.youtube.com/watch?v=47dhAF1Hoco){:target="_blank"} to learn how to use event names to filter events sent to destinations.
109+
[Watch this destination filters walkthrough](https://www.youtube.com/watch?v=47dhAF1Hoco){:target="_blank"} to learn how to use event names to filter events sent to destinations.
109110

110111
## Important notes
111112

112113
#### Conflicting settings
113114

114-
Some destinations offer settings that also allow you to filter data. For example, the Facebook App Events destination allows you to map `Screen` events to `Track` events. Because Destination Filters are evaluated and applied _before_ the Destination settings are applied, they can conflict with your settings.
115+
Some destinations offer settings that also allow you to filter data. For example, the Facebook App Events destination allows you to map `Screen` events to `Track` events. Because destination filters are evaluated and applied _before_ the destination settings are applied, they can conflict with your settings.
115116

116-
For example, if you have a Destination Filter that filters Track events _and_ you have the **Use Screen Events as Track Events** setting enabled, `Track` events drop, but `Screen` events still process. The destination settings transform it into a `Track` event - *after* the filters.
117+
For example, if you have a destination filter that filters Track events _and_ you have the **Use Screen Events as Track Events** setting enabled, `Track` events drop, but `Screen` events still process. The destination settings transform it into a `Track` event - *after* the filters.
117118

118119
#### Error handling
119120

120-
Segment makes effort to ensure that Destination Filters can handle unexpected situations. For example, if you use the `contains()` FQL function on the `null` field, Segment returns `false` instead of returning an error. If Segment can't infer your intent, Segment logs an internal error and drops the event. Segment defaults to this behavior to prevent sensitive information, like a PII filter, from getting through.
121+
Segment makes effort to ensure that destination filters can handle unexpected situations. For example, if you use the `contains()` FQL function on the `null` field, Segment returns `false` instead of returning an error. If Segment can't infer your intent, Segment logs an internal error and drops the event. Segment defaults to this behavior to prevent sensitive information, like a PII filter, from getting through.
121122

122123
Errors aren't exposed in your Destination's Event Deliverability tab. For help diagnosing missing destination filter events, [contact Segment](https://segment.com/help/contact/){:target="_blank"}.
123124

124125
## FAQs
125126

126-
#### How do Destination Filters work with array properties?
127+
#### How do destination filters work with array properties?
127128

128-
Destination Filters can filter properties out of objects nested in an array. For 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.
129+
Destination filters can filter properties out of objects nested in an array. For 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.
129130

130131
To block a specific property from all of the objects within a properties array, set the filter using the following the format: `<propertyType>.<arrayName>.<arrayElementLabel>​`.
131132

@@ -141,7 +142,7 @@ Segment supports 10 filters per destination. If you need help consolidating filt
141142

142143
#### Can I set multiple `Only Send` destination filters?
143144

144-
Segment evaluates multiple `Only Send` filters against each other and resolves Destination Filters in order. If multiple `Only Send` filters conflict with each other, Segment won't send information downstream.
145+
Segment evaluates multiple `Only Send` filters against each other and resolves destination filters in order. If multiple `Only Send` filters conflict with each other, Segment won't send information downstream.
145146

146147
#### How many properties can I view in the filter dropdown?
147148

@@ -155,14 +156,14 @@ To filter out events from warehouses, use Selective Sync.
155156

156157
Generally, only Track calls have *name* properties, which correspond to the *event* field in an event.
157158

158-
#### How can I find out when new Destination Filters have been added or removed?
159+
#### How can I find out when new destination filters have been added or removed?
159160

160-
The Activity Feed shows the action, date, and user who performed the action when a Destination Filter is created, modified, enabled, disabled, or deleted. You can also subscribe to notifications for any of these changes in the **Activity Feed** settings page.
161+
The Activity Feed shows the action, date, and user who performed the action when a destination filter is created, modified, enabled, disabled, or deleted. You can also subscribe to notifications for any of these changes in the **Activity Feed** settings page.
161162

162163
#### Why am I getting a permissions denied error when I try to save a filter?
163164

164165
You must have write access to save and edit filters. Read permission access only allows viewing and testing access.
165166

166167
#### How can I test my filter?
167168

168-
Use the Destination Filter tester during setup to verify that you're filtering out the right events. Filtered events show up on the schema page but aren't counted in event deliverability graphs.
169+
Use the destination filter tester during setup to verify that you're filtering out the right events. Filtered events show up on the schema page but aren't counted in event deliverability graphs.

0 commit comments

Comments
 (0)