Skip to content

Commit 8b38993

Browse files
stayseesongstayseesong
committed
fixes for sources and destinations
1 parent 53f3965 commit 8b38993

File tree

3 files changed

+56
-37
lines changed

3 files changed

+56
-37
lines changed

‎src/connections/destinations/destination-filters.md

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

6-
Use Destination Filters to prevent certain data from flowing into a destination.
7-
8-
With Destination Filters, you can conditionally filter out event properties, traits, and fields, or even filter out the event itself.
9-
10-
Common use cases for Destination Filters include the following:
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.
117

8+
Common use cases for Destination Filters include:
129
- Managing PII (personally identifiable information) by blocking fields from reaching certain destinations
1310
- Controlling event volume by sampling or dropping unnecessary events for specific destinations
1411
- Increasing data relevance in your destinations by removing unused or unwanted data
1512
- Preventing test or internally-generated events from reaching your production tools
1613

17-
> note ""
18-
> Destination Filters are available to Business Tier customers only.
14+
> info ""
15+
> Destination Filters are only available to Business Tier customers.
1916
2017
### Destination filtering limitations
2118

@@ -30,8 +27,7 @@ Keep the following limitations in mind when you use Destination Filters:
3027

3128
## Create a Destination Filter
3229

33-
To create a Destination Filter, follow these steps:
34-
30+
To create a Destination Filter:
3531
1. Go to **Connections > Destinations** and select your destination.
3632
2. Click on the **Filters** tab of your destination.
3733
3. Click **+ New Filter**.
@@ -43,16 +39,16 @@ To create a Destination Filter, follow these steps:
4339

4440
## Destination Filters API
4541

46-
The Destination Filters API provides more power than the Segment dashboard's Destination Filters settings. With the API, you can create complex filters that are conditionally applied using Segment's [Filter Query Language (FQL)](/docs/config-api/fql).
42+
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/config-api/fql).
4743

4844
The Destination Filters API offers four different filter types:
4945

5046
| Filter | Details |
5147
| ------------------ | ------------------------------------------------------------ |
52-
| `drop_event` | Don't send matched events to the destination. |
53-
| `sample_event` | Send only a percentage of events through to the destination. |
54-
| `whitelist_fields` | Only send whitelisted properties to the destination. |
55-
| `blocklist_fields` | Don't send blocklisted properties to the destination. |
48+
| `drop_event` | Doesn't send matched events to the destination. |
49+
| `sample_event` | Sends only a percentage of events through to the destination. |
50+
| `whitelist_fields` | Only sends whitelisted properties to the destination. |
51+
| `blocklist_fields` | Doesn't send blocklisted properties to the destination. |
5652

5753
To learn more, read Segment's [Destination Filters API docs](https://reference.segmentapis.com/#6c12fbe8-9f84-4a6c-848e-76a2325cb3c5){:target="_blank"}.
5854

@@ -105,7 +101,7 @@ Using the [Destination Filters API](https://reference.segmentapis.com/#6c12fbe8-
105101

106102
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.
107103

108-
In the example in the video above, if you have a Destination Filter that filters Track events _and_ you have the **Use Screen Events as Track Events** setting enabled, `Track` events will be dropped, but `Screen` events still process. The destination settings will transform it into a `Track` event - *after* the filters.
104+
In the example in [the video](https://www.youtube.com/watch?v=47dhAF1Hoco){:target="_blank"}, 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 will transform it into a `Track` event - *after* the filters.
109105

110106
**Error handling**
111107

@@ -115,7 +111,7 @@ Errors aren't exposed in your Destination's Event Deliverability tab. For help d
115111

116112
## FAQ
117113

118-
**How do Destination Filters work with array properties?**
114+
#### How do Destination Filters work with array properties?
119115

120116
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.
121117

@@ -127,36 +123,36 @@ For example, the `properties.products.newElement` filter blocks all `newElement`
127123

128124
To block the Identify event trait `products.newElement`, select the option under the **User Traits** list instead. To block a context object field `products.newElement`, select it from the **Context Fields** list.
129125

130-
**How many filters can I create?**
126+
#### How many filters can I create?
131127

132128
Segment supports 10 filters per destination. If you need help consolidating filters or would like to discuss your use case, [contact Segment](https://segment.com/help/contact/){:target="_blank"}.
133129

134-
**Can I set multiple `Only Send` Destination Filters?**
130+
#### Can I set multiple `Only Send` Destination Filters?
135131

136132
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.
137133

138-
**How many properties can I view in the filter dropdown?**
134+
#### How many properties can I view in the filter dropdown?
139135

140136
Segment displays the most recent 15,000 properties. To find a property not in the filter dropdown, enter the property manually.
141137

142-
**How can I filter out warehouse events?**
138+
#### How can I filter out warehouse events?
143139

144140
To filter out events from warehouses, use Selective Sync.
145141

146-
**I don't see a `name` property at the top level of my events to filter on "event name".**
142+
#### I don't see a `name` property at the top level of my events to filter on "event name".
147143

148144
Generally, only Track calls have "name" properties, which correspond to the "Event" field in an event.
149145

150-
**How can I find out when new Destination Filters have been added or removed?**
146+
#### How can I find out when new Destination Filters have been added or removed?
151147

152148
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.
153149

154150
The Activity Feed shows the user, date, and action performed when a Destination Filter is created, modified, enabled, disabled, or deleted.
155151

156-
**Why am I getting a permissions denied error when I try to save a filter?**
152+
#### Why am I getting a permissions denied error when I try to save a filter?
157153

158154
You must have write access to save and edit filters; read permission allows viewing and testing access only.
159155

160-
**How can I test my filter?**
156+
#### How can I test my filter?
161157

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

‎src/connections/destinations/index.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@
22
title: Destinations Overview
33
---
44

5+
Destinations receive data from Segment.
6+
7+
58
If you just want to explore the Segment destinations, check out the [Destinations catalog](/docs/connections/destinations/catalog/).
69

710
Select an item from the catalog to learn more about it. The documentation for each destination explains how the Segment Tracking API methods are implemented for that destination.

‎src/connections/sources/index.md

Lines changed: 33 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,9 @@ excerpt: Detailed information about each Source. Learn how our API methods are i
1010

1111
## What is a source?
1212

13-
In Segment, you create a source (or more than one!) for each website or app you want to track. While it's not required that you have a single Source for each server, site or app, you should create a Source for each unique source of data.
13+
A Source is a website, server library, mobile SDK, or cloud application which can send data into Segment. It’s where your data originates. Add a Source to collect data to understand who your customers are and how they’re using your product. Create a source for each website or app you want to track. While it's not required that you have a single source for each server, site, or app, you should create a source for each unique source of data.
1414

15-
You can create new sources using the button in the workspace view. Each source you create has a write key, which is used to send data to that source. For example, to load [`analytics.js`, the Segment JavaScript library](https://segment.com/docs/connections/sources/catalog/libraries/website/javascript/) on your page, the snippet on the [Quickstart Guide](https://segment.com/docs/connections/sources/catalog/libraries/website/javascript/quickstart/) includes:
15+
Each source you create has a write key, which is used to send data to that source. For example, to load [`analytics.js`, the Segment JavaScript library](https://segment.com/docs/connections/sources/catalog/libraries/website/javascript/) on your page, the snippet on the [Quickstart Guide](https://segment.com/docs/connections/sources/catalog/libraries/website/javascript/quickstart/) includes:
1616

1717

1818
```js
@@ -49,6 +49,26 @@ analytics.identify('user_123', {
4949
{% endcomment %}
5050
---
5151

52+
53+
## Types of sources
54+
55+
Segment has five types of sources:
56+
* [Web](#website-libraries)
57+
* [Mobile](#mobile)
58+
* [Server](#server)
59+
* [Cloud App](#cloud-apps)
60+
* User-created [Source Functions](/docs/connections/sources/source-functions/)
61+
62+
Web, Mobile, and Server sources send first-party data from your digital properties. Cloud-app sources send data about your users from your connected web apps such as [Zendesk](/docs/connections/sources/catalog/cloud-apps/zendesk/), [Stripe](/docs/connections/sources/catalog/cloud-apps/stripe/), and [Braze](/docs/connections/sources/catalog/cloud-apps/braze/).
63+
64+
## Create a source
65+
To create a source:
66+
1. Navigate to **Connections** and click **Add Source**.
67+
2. Click the Source you’d like to add. *Note:* More than 80% of workspaces start by adding their JavaScript website.
68+
3. Click **Add Source**.
69+
4. Enter a name for your source as well as any information on the setup page.
70+
5. Click **Add Source**.
71+
5272
## Website libraries
5373

5474
[Analytics.js](/docs/connections/sources/catalog/libraries/website/javascript/), the JavaScript library, is the most powerful way to track customer data from your website. If you're just starting out, Segment recommends it over server-side libraries as the simplest installation for any website.
@@ -79,7 +99,7 @@ Segment's Mobile SDKs are the best way to simplify your iOS, Android, and Xamari
7999

80100
## Server
81101

82-
Segment's server-side sources let you send analytics data directly from your servers. Segment recommends tracking from your servers when device-mode tracking (tracking on the client) won't work. Check out the [guide on server-side tracking](/docs/guides/how-to-guides/collect-on-client-or-server/) if you're not sure whether it makes sense for your use case.
102+
Segment's server-side sources let you send analytics data directly from your servers. Segment recommends tracking from your servers when device-mode tracking (tracking on the client) doesn't work. Check out the [guide on server-side tracking](/docs/guides/how-to-guides/collect-on-client-or-server/) if you're not sure whether it makes sense for your use case.
83103

84104
{: .columns }
85105
- [Clojure](/docs/connections/sources/catalog/libraries/server/clojure/)
@@ -91,16 +111,16 @@ Segment's server-side sources let you send analytics data directly from your ser
91111
- [Ruby](/docs/connections/sources/catalog/libraries/server/ruby/)
92112
- [.NET](/docs/connections/sources/catalog/libraries/server/net/)
93113

94-
> note "Cloud-mode tracking"
95-
> Server-side data management is when tag sends data to the Segment servers, which then pass that data to the destination system.
114+
> info "Cloud-mode tracking"
115+
> Server-side data management is when tag sends data to the Segment servers, which then passes that data to the destination system.
96116
97117
---
98118

99119
## Cloud Apps
100120

101-
Cloud app sources empower you to pull together data from all of your different third-party tools into a Segment warehouse or to your other enabled integrated tools. There are two types of Cloud Apps: **Object** and **Event** sources.
121+
Cloud app sources empower you to pull together data from all of your different third-party tools into a Segment warehouse or to your other enabled integrated tools. They send data about your users from your connected web apps. There are two types of Cloud Apps: **Object** and **Event** sources.
102122

103-
{% include components/reference-button.html href="/docs/connections/sources/sources-compare/" icon="guides.svg" title="Comparing Cloud Sources" description="Wondering which cloud-apps send which types of data? Check out the Cloud Sources comparison!" %}
123+
{% include components/reference-button.html href="/docs/connections/sources/sources-compare/" icon="guides.svg" title="Comparing Cloud Sources" description="Wondering which cloud-apps send which types of data? Check out the Cloud Sources comparison." %}
104124

105125
### Object Cloud Sources
106126

@@ -133,9 +153,9 @@ Segment's [Pixel Tracking API](/docs/connections/sources/catalog/libraries/serve
133153

134154
| Event name | Description |
135155
| --- | --- |
136-
| Email Delivered | Message has been successfully delivered to the receiving server |
137-
| Email Opened | Recipient has opened the HTML message. You need to enable Open Tracking for getting this type of event |
138-
| Email Link Clicked | Recipient clicked on a link within the message. You need to enable Click Tracking for getting this type of event |
139-
| Email Bounced | Receiving server could not or would not accept message |
140-
| Email Marked as Spam | Recipient marked message as spam |
141-
| Unsubscribe | Recipient clicked on message's subscription management link |
156+
| Email Delivered | The message has been successfully delivered to the receiving server |
157+
| Email Opened | The recipient has opened the HTML message. You need to enable Open Tracking for getting this type of event. |
158+
| Email Link Clicked | The recipient clicked on a link within the message. You need to enable Click Tracking for getting this type of event. |
159+
| Email Bounced | The receiving server could not or would not accept message. |
160+
| Email Marked as Spam | The recipient marked message as spam. |
161+
| Unsubscribe | The recipient clicked on message's subscription management link. |

0 commit comments

Comments
 (0)