You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: src/connections/destinations/destination-filters.md
+9-9Lines changed: 9 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,30 +3,30 @@ title: Destination Filters
3
3
rewrite: true
4
4
---
5
5
6
-
Use Destination Filters to prevent certain data from flowing into a destination. With Destination Filters, you can conditionally filter out event properties, traits, and fields, or even filter out the event itself.
6
+
> info ""
7
+
> Destination filters are only available to Business Tier customers.
8
+
9
+
Use destination filters to prevent certain data from flowing into a destination. You can conditionally filter out event properties, traits, and fields, or even filter out the event itself.
10
+
11
+
You can configure destination filters on cloud-mode destinations as well as on mobile and web device-mode destinations. With device-mode destinations, you can use the same user interface or API mechanism that you use for your cloud-mode destinations, and have those filters acted upon for device-mode destinations on web and mobile.
7
12
8
-
Common use cases for Destination Filters include:
13
+
Common use cases for destination filters include:
9
14
- Managing PII (personally identifiable information) by blocking fields from reaching certain destinations
10
15
- Controlling event volume by sampling or dropping unnecessary events for specific destinations
11
16
- Increasing data relevance in your destinations by removing unused or unwanted data
12
17
- Preventing test or internally-generated events from reaching your production tools
13
18
14
-
> info ""
15
-
> Destination Filters are only available to Business Tier customers.
16
-
17
19
### Limitations
18
20
19
21
Keep the following limitations in mind when you use Destination Filters:
20
22
21
23
- Segment applies Destination Filters one at a time in the order that they appear in your workspace.
22
-
- Destination Filters can only be applied to cloud-mode (server-side) streaming destinations.
23
-
- Device-mode destinations aren't supported.
24
24
- You can't apply Destination Filters to Warehouses or S3 destinations.
25
25
- Each filter can only apply to one source-destination pair.
26
26
27
27
[Contact Segment](https://segment.com/help/contact/){:target="_blank"} if these limitations impact your use case.
28
28
29
-
## Create a Destination Filter
29
+
## Create a destination filter
30
30
31
31
To create a Destination Filter:
32
32
1. Go to **Connections > Destinations** and select your destination.
@@ -38,7 +38,7 @@ To create a Destination Filter:
38
38
7. Name your filter and click the toggle to enable it.
39
39
8. Click **Save**.
40
40
41
-
## Destination Filters API
41
+
## Destination filters API
42
42
43
43
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/).
Copy file name to clipboardExpand all lines: src/connections/sources/catalog/libraries/mobile/kotlin-android/index.md
+20-2Lines changed: 20 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -340,8 +340,26 @@ analytics.add(yourPlugin)
340
340
```
341
341
342
342
### Example projects using Analytics-Kotlin
343
-
See how different platforms and languages use Analytics-Kotlin in different [example projects](https://github.com/segmentio/analytics-kotlin/tree/main/samples).
344
-
The example projects contain sample [plugins](https://github.com/segmentio/analytics-kotlin/tree/main/samples/kotlin-android-app/src/main/java/com/segment/analytics/next/plugins) and [destination plugins](https://github.com/segmentio/analytics-kotlin/tree/main/samples/kotlin-android-app-destinations/src/main/java/com/segment/analytics/destinations/plugins) you can utilize.
343
+
See how different platforms and languages use Analytics-Kotlin in different [example projects](https://github.com/segmentio/analytics-kotlin/tree/main/samples){:target="_blank"}.
344
+
The example projects contain sample [plugins](https://github.com/segmentio/analytics-kotlin/tree/main/samples/kotlin-android-app/src/main/java/com/segment/analytics/next/plugins){:target="_blank"} and [destination plugins](https://github.com/segmentio/analytics-kotlin/tree/main/samples/kotlin-android-app-destinations/src/main/java/com/segment/analytics/destinations/plugins){:target="_blank"} you can utilize.
345
+
346
+
## Destination filters
347
+
> info ""
348
+
> Destination filters are only available to Business Tier customers.
349
+
350
+
You can set up [destination filters](docs/connections/destinations/destination-filters/) on your mobile device-mode destinations by using Analytics Kotlin (Android).
351
+
352
+
To get started with destination filters on mobile device-mode destinations using Kotlin:
Copy file name to clipboardExpand all lines: src/connections/sources/catalog/libraries/mobile/swift-ios/index.md
+24-5Lines changed: 24 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -13,7 +13,7 @@ If you're migrating to Analytics-Swift from a different mobile library, you can
13
13
> Analytics-Swift currently supports [these destinations](#supported-destinations) in device-mode, with more to follow. Cloud-mode destinations are also supported.
14
14
15
15
16
-
## Getting Started
16
+
## Getting started
17
17
To get started with the Analytics-Swift mobile library:
18
18
19
19
1. Create a Source in Segment.
@@ -62,7 +62,7 @@ To get started with the Analytics-Swift mobile library:
62
62
> info ""
63
63
> Configuration options such as IDFA collection and automatic screen tracking are found in Segment's [Plugin Examples repo](https://github.com/segmentio/analytics-example-plugins/tree/main/plugins/swift){:target="_blank"}.
64
64
65
-
## Tracking Methods
65
+
## Tracking methods
66
66
Once you've installed the Analytics-Swift library, you can start collecting data through Segment's tracking methods:
Segment's plugin architecture enables you to modify and augment how the analytics client works. From modifying event payloads to changing analytics functionality, plugins help to speed up the process of getting things done.
209
209
210
210
Plugins are run through a timeline, which executes in order of insertion based on their entry types. Segment has these 5 entry types:
Though you can add plugins anywhere in your code, it's best to implement your plugin when you configure the client.
335
335
336
-
## Utility Methods
336
+
## Destination filters
337
+
> info ""
338
+
> Destination filters are only available to Business Tier customers.
339
+
340
+
You can set up [destination filters](docs/connections/destinations/destination-filters/) on your mobile device-mode destinations by using Analytics Swift.
341
+
342
+
To get started with destination filters using Swift:
343
+
1. Add the plugin dependency to your application by adding the Swift package `git@github.com:segmentio/DestinationFilters-Swift.git` as a dependency through either of these 2 options:
344
+
1. Your package.swift file
345
+
2. Xcode
346
+
1. Xcode 12:**File > Swift Packages > Add Package Dependency**
347
+
2. Xcode 13:**File > Add Packages...**
348
+
349
+
After installing the package, you can reference the Destination Filters plugin by importing the package with `importDestinationFilters_Swift`.
350
+
2. Add the plugin.
351
+
```swift
352
+
analytics.add(DestinationFilters())
353
+
```
354
+
355
+
## Utility methods
337
356
The Analytics Swift utility methods help you work with [plugins](#plugin-architecture) from the analytics timeline. They include:
338
357
- [Add](#add)
339
358
- [Find](#find)
@@ -419,7 +438,7 @@ let idfaPlugin = IDFACollection()
419
438
analytics.add(plugin: idfaPlugin)
420
439
```
421
440
422
-
## Supported Destinations
441
+
## Supported destinations
423
442
Segment supports these destinations for Analytics Swift, with more to come:
0 commit comments