Skip to content

Commit 705ec4a

Browse files
committed
destination filters [netlify-build]
1 parent a5e18bb commit 705ec4a

File tree

3 files changed

+53
-16
lines changed

3 files changed

+53
-16
lines changed

src/connections/destinations/destination-filters.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -3,30 +3,30 @@ title: Destination Filters
33
rewrite: true
44
---
55

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.
712

8-
Common use cases for Destination Filters include:
13+
Common use cases for destination filters include:
914
- Managing PII (personally identifiable information) by blocking fields from reaching certain destinations
1015
- Controlling event volume by sampling or dropping unnecessary events for specific destinations
1116
- Increasing data relevance in your destinations by removing unused or unwanted data
1217
- Preventing test or internally-generated events from reaching your production tools
1318

14-
> info ""
15-
> Destination Filters are only available to Business Tier customers.
16-
1719
### Limitations
1820

1921
Keep the following limitations in mind when you use Destination Filters:
2022

2123
- 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.
2424
- You can't apply Destination Filters to Warehouses or S3 destinations.
2525
- Each filter can only apply to one source-destination pair.
2626

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

29-
## Create a Destination Filter
29+
## Create a destination filter
3030

3131
To create a Destination Filter:
3232
1. Go to **Connections > Destinations** and select your destination.
@@ -38,7 +38,7 @@ To create a Destination Filter:
3838
7. Name your filter and click the toggle to enable it.
3939
8. Click **Save**.
4040

41-
## Destination Filters API
41+
## Destination filters API
4242

4343
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/).
4444

src/connections/sources/catalog/libraries/mobile/kotlin-android/index.md

Lines changed: 20 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -340,8 +340,26 @@ analytics.add(yourPlugin)
340340
```
341341

342342
### 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:
353+
354+
1. Download and install the dependency.
355+
```java
356+
implementation 'com.segment.analytics.kotlin:destination-filters-kotlin:x.x.x'
357+
```
358+
359+
2. Add the plugin.
360+
```java
361+
analytics.add(DestinationFilters())
362+
```
345363

346364
## Utility methods
347365
The Analytics-Kotlin utility methods help you work with plugins from the analytics timeline. They include:

src/connections/sources/catalog/libraries/mobile/swift-ios/index.md

Lines changed: 24 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ If you're migrating to Analytics-Swift from a different mobile library, you can
1313
> Analytics-Swift currently supports [these destinations](#supported-destinations) in device-mode, with more to follow. Cloud-mode destinations are also supported.
1414
1515

16-
## Getting Started
16+
## Getting started
1717
To get started with the Analytics-Swift mobile library:
1818

1919
1. Create a Source in Segment.
@@ -62,7 +62,7 @@ To get started with the Analytics-Swift mobile library:
6262
> info ""
6363
> 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"}.
6464

65-
## Tracking Methods
65+
## Tracking methods
6666
Once you've installed the Analytics-Swift library, you can start collecting data through Segment's tracking methods:
6767
- [Identify](#identify)
6868
- [Track](#track)
@@ -204,7 +204,7 @@ analytics.alias(newId: "user-123")
204204
{% endcodeexampletab %}
205205
{% endcodeexample %}
206206

207-
## Plugin Architecture
207+
## Plugin architecture
208208
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.
209209

210210
Plugins are run through a timeline, which executes in order of insertion based on their entry types. Segment has these 5 entry types:
@@ -333,7 +333,26 @@ analytics.add(plugin: yourIntegration)
333333

334334
Though you can add plugins anywhere in your code, it's best to implement your plugin when you configure the client.
335335

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 `import DestinationFilters_Swift`.
350+
2. Add the plugin.
351+
```swift
352+
analytics.add(DestinationFilters())
353+
```
354+
355+
## Utility methods
337356
The Analytics Swift utility methods help you work with [plugins](#plugin-architecture) from the analytics timeline. They include:
338357
- [Add](#add)
339358
- [Find](#find)
@@ -419,7 +438,7 @@ let idfaPlugin = IDFACollection()
419438
analytics.add(plugin: idfaPlugin)
420439
```
421440

422-
## Supported Destinations
441+
## Supported destinations
423442
Segment supports these destinations for Analytics Swift, with more to come:
424443
* [Amplitude](https://github.com/segment-integrations/analytics-swift-amplitude)
425444
* [Appsflyer](https://github.com/segment-integrations/analytics-swift-appsflyer)

0 commit comments

Comments
 (0)