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/reverse-etl/index.md
+20-20Lines changed: 20 additions & 20 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,7 +1,7 @@
1
1
---
2
2
title: Reverse ETL
3
3
beta: false
4
-
redirect_from:
4
+
redirect_from:
5
5
- '/reverse-etl/'
6
6
---
7
7
@@ -10,7 +10,7 @@ Reverse ETL (Extract, Transform, Load) extracts data from a data warehouse using
10
10
## Example use cases
11
11
Use Reverse ETL when you want to:
12
12
* Sync audiences and other data built in the warehouse to Braze, Hubspot, or Salesforce Marketing Cloud for personalized marketing campaigns.
13
-
* Sync enriched data to Mixpanel for a more complete view of the customer, or enrich Segment Profiles with data from the warehouse.
13
+
* Sync enriched data to Mixpanel for a more complete view of the customer, or enrich Segment Unify with data from the warehouse.
14
14
* Send data in the warehouse back into Segment as events that can be activated in all supported destinations, including Twilio Engage and other platforms.
15
15
* Pass offline or enriched data to conversion APIs like Facebook, Google Ads, TikTok, or Snapchat.
16
16
* Connect Google Sheets to a view in the warehouse for other business teams to have access to up-to-date reports.
@@ -27,7 +27,7 @@ Follow these 4 steps to set up Reverse ETL and learn what each component is abou
27
27
4.[Create Mappings](#step-4-create-mappings)
28
28
29
29
> info ""
30
-
> The UI navigation and interface will look different from what's presented in the docs until Reverse ETL rolls out to all users for GA.
30
+
> The UI navigation and interface will look different from what's presented in the docs until Reverse ETL rolls out to all users for GA.
31
31
32
32
### Step 1: Add a source
33
33
A source is where your data originates from. Traditionally in Segment, a [source](/docs/connections/sources/#what-is-a-source) is a website, server library, mobile SDK, or cloud application which can send data into Segment. In Reverse ETL, your data warehouse is the source.
@@ -40,7 +40,7 @@ To add your warehouse as a source:
40
40
1. Navigate to **Connections > Sources** and select the **Reverse ETL** tab in the Segment app.
41
41
2. Click **Add Reverse ETL source**.
42
42
3. Select the source you want to add. You can choose between BigQuery, Redshift, and Snowflake.
43
-
4. Follow the corresponding setup guide for your Reverse ETL source.
43
+
4. Follow the corresponding setup guide for your Reverse ETL source.
@@ -85,7 +85,7 @@ If your destination is not listed in the Reverse ETL catalog, use the [Segment C
85
85
To add your first destination:
86
86
1. Navigate to **Connections > Destinations** and select the **Reverse ETL** tab.
87
87
2. Click **Add Reverse ETL destination**.
88
-
3. Select the destination you want to connect to and click **Configure**.
88
+
3. Select the destination you want to connect to and click **Configure**.
89
89
4. Select the Reverse ETL source you want to connect the destination to.
90
90
5. Enter the **Destination name** and click **Create Destination**.
91
91
6. Enter the required information on the **Settings** tab of the destination.
@@ -95,7 +95,7 @@ To add your first destination:
95
95
After you’ve added a destination, you can create mappings from your warehouse to the destination. Mappings enable you to map the data you extract from your warehouse to the fields in your destination.
96
96
97
97
To create a mapping:
98
-
1. Navigate to **Conections > Destinations** and select the **Reverse ETL** tab.
98
+
1. Navigate to **Conections > Destinations** and select the **Reverse ETL** tab.
99
99
2. Select the destination that you want to create a mapping for.
100
100
3. Click **Add Mapping**.
101
101
2. Select the model to sync from.
@@ -123,15 +123,15 @@ After you've followed [all four steps](/docs/connections/reverse-etl/#getting-st
123
123
Check the status of your data extractions and see details of your syncs. Click into failed records to view additional details on the error, sample payloads to help you debug the issue, and recommended actions.
124
124
125
125
To check the status of your extractions:
126
-
1. Navigate to **Connections > Destinations** and select the **Reverse ETL** tab.
126
+
1. Navigate to **Connections > Destinations** and select the **Reverse ETL** tab.
127
127
2. Select the destination you want to view.
128
128
3. Select the mapping you want to view.
129
129
4. Click the sync you want to view to get details of the sync. You can view:
130
130
* The status of the sync.
131
131
* Details of how long it took for the sync to complete.
132
-
* How many total records were extracted, as well as a breakdown of the number of records added, updated, and deleted.
132
+
* How many total records were extracted, as well as a breakdown of the number of records added, updated, and deleted.
133
133
* The load results - how many successful records were synced as well as how many records were updated, deleted, or are new.
134
-
5. If your sync failed, click the failed reason to get more details on the error and view sample payloads to help troubleshoot the issue.
134
+
5. If your sync failed, click the failed reason to get more details on the error and view sample payloads to help troubleshoot the issue.
135
135
136
136
137
137
### Edit your model
@@ -151,12 +151,12 @@ To edit your mapping:
151
151
152
152
153
153
## Record diffing
154
-
Reverse ETL computes the incremental changes to your data directly within your data warehouse. The Unique Identifier column is used to detect the data changes, such as new, updated, and deleted records.
154
+
Reverse ETL computes the incremental changes to your data directly within your data warehouse. The Unique Identifier column is used to detect the data changes, such as new, updated, and deleted records.
155
155
156
-
In order for Segment to compute the data changes within your warehouse, Segment needs to have both read and write permissions to the warehouse schema table. At a high level, the extract process requires read permissions for the query being executed. Segment keeps track of changes to the query results through tables that Segment manages in a dedicated schema (for example, `_segment_reverse_etl`), which requires some write permissions.
156
+
In order for Segment to compute the data changes within your warehouse, Segment needs to have both read and write permissions to the warehouse schema table. At a high level, the extract process requires read permissions for the query being executed. Segment keeps track of changes to the query results through tables that Segment manages in a dedicated schema (for example, `_segment_reverse_etl`), which requires some write permissions.
157
157
158
158
> warning ""
159
-
> There may be cost implications to having Segment query your warehouse tables.
159
+
> There may be cost implications to having Segment query your warehouse tables.
160
160
161
161
## Segment Connections destination
162
162
If you don’t see your destination listed in the Reverse ETL catalog, use the [Segment Connections destination](/docs/connections/destinations/catalog/actions-segment/) to send data from your Reverse ETL warehouse to other destinations listed in the [catalog](/docs/connections/destinations/catalog/).
@@ -167,22 +167,22 @@ The Segment Connections destination enables you to mold data extracted from your
167
167
> The Segment Connections destination sends data to Segment’s Tracking API, which has cost implications. New users count as new MTUs and each call counts as an API call. For information on how Segment calculates MTUs and API calls, please see [MTUs, Throughput and Billing](/docs/guides/usage-and-billing/mtus-and-throughput/).
168
168
169
169
## Limits
170
-
To provide consistent performance and reliability at scale, Segment enforces default use and rate limits for Reverse ETL.
170
+
To provide consistent performance and reliability at scale, Segment enforces default use and rate limits for Reverse ETL.
171
171
172
172
### Usage limits
173
-
Reverse ETL usage limits are measured based on the number of records processed to each destination – this includes both successful and failed records. For example, if you processed 50k records to Braze and 50k records to Mixpanel, then your total Reverse ETL usage is 100k records.
173
+
Reverse ETL usage limits are measured based on the number of records processed to each destination – this includes both successful and failed records. For example, if you processed 50k records to Braze and 50k records to Mixpanel, then your total Reverse ETL usage is 100k records.
174
174
175
-
Processed records represents the number of records Segment attempts to send to each destination. Keep in mind that not all processed records are successfully delivered, for example, such as when the destination experiences an issue.
175
+
Processed records represents the number of records Segment attempts to send to each destination. Keep in mind that not all processed records are successfully delivered, for example, such as when the destination experiences an issue.
176
176
177
-
Your plan determines how many Reverse ETL records you can process in one monthly billing cycle. When your limit is reached before the end of your billing period, your syncs will pause and then resume on your next billing cycle. To see how many records you’ve processed using Reverse ETL, navigate to **Settings > Usage & billing** and select the **Reverse ETL** tab.
177
+
Your plan determines how many Reverse ETL records you can process in one monthly billing cycle. When your limit is reached before the end of your billing period, your syncs will pause and then resume on your next billing cycle. To see how many records you’ve processed using Reverse ETL, navigate to **Settings > Usage & billing** and select the **Reverse ETL** tab.
178
178
179
179
Plan | Number of Reverse ETL records you can process to destinations per month | How to increase your number of Reverse ETL records
Free | 500K | Upgrade to the Teams plan in the Segment app by navigating to **Settings > Usage & billing**.
182
-
Teams | 1 million | Contact your sales representative to upgrade your plan to Business.
183
-
Business | 50 x the number of [MTUs](/docs/guides/usage-and-billing/mtus-and-throughput/#what-is-an-mtu) <br>or .25 x the number of monthly API calls | Contact your sales rep to upgrade your plan.
182
+
Teams | 1 million | Contact your sales representative to upgrade your plan to Business.
183
+
Business | 50 x the number of [MTUs](/docs/guides/usage-and-billing/mtus-and-throughput/#what-is-an-mtu) <br>or .25 x the number of monthly API calls | Contact your sales rep to upgrade your plan.
184
184
185
-
If you have a non-standard or high volume usage plan, you may have unique Reverse ETL limits or custom pricing.
185
+
If you have a non-standard or high volume usage plan, you may have unique Reverse ETL limits or custom pricing.
186
186
187
187
### Configuration limits
188
188
@@ -194,7 +194,7 @@ Model timestamp column name length | The maximum length for the timestamp column
194
194
Sync frequency | The shortest possible duration Segment allows between syncs. | 15 minutes
195
195
196
196
### Extract limits
197
-
The extract phase is the time spent connecting to your database, executing the model query, updating internal state tables and staging the extracted records for loading.
197
+
The extract phase is the time spent connecting to your database, executing the model query, updating internal state tables and staging the extracted records for loading.
Copy file name to clipboardExpand all lines: src/engage/audiences/index.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -28,7 +28,7 @@ You can also specify two different types of time-windows, `within` and `in betwe
28
28
29
29
### Custom Traits
30
30
31
-
You can also build Audiences based on custom traits. These traits can be collected from your apps when a user completes a form or signs up using an [Identify](/docs/connections/spec/identify) call. You can view these traits in the user explorer, as well.
31
+
You can also build Audiences based on custom traits. These traits can be collected from your apps when a user completes a form or signs up using an [Identify](/docs/connections/spec/identify) call. You can view these traits in the Profile explorer, as well.
Copy file name to clipboardExpand all lines: src/engage/journeys/journeys-logic.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -113,7 +113,7 @@ Yes. To allow users to re-enter Journeys that they've exited, [enable re-entry](
113
113
114
114
### What happens to traits and audiences when I delete a Journey?
115
115
116
-
Deleting a Journey removes its underlying audiences from profile views in the Profiles Explorer. However, the Journey's True/False traits remain in the user's last recorded state.
116
+
Deleting a Journey removes its underlying audiences from profile views in the Profile explorer. However, the Journey's True/False traits remain in the user's last recorded state.
117
117
118
118
> info "Note"
119
119
> Cloning a Journey generates new, unique traits and sync keys. Deleting the original Journey won't impact any cloned Journeys.
Copy file name to clipboardExpand all lines: src/engage/quickstart.md
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -18,7 +18,7 @@ To configure and use Engage, you need the following:
18
18
19
19
1.**A Segment account and Workspace.**
20
20
2.**Events flowing into Connections** from your digital properties where most of your valuable user behavior occurs.
21
-
3.**Profiles identity admin access.** You must have edit access to identity resolution rules.
21
+
3.**Unify identity admin access.** You must have edit access to identity resolution rules.
22
22
4.**Engage Administrator access.** You must be either be a workspace admin, or a workspace user with Engage admin access to set up audiences and computed traits. You can check your permissions by navigating to [Access Management](https://app.segment.com/goto-my-workspace/settings/access-management){:target="_blank"} in your workspace settings. See the [Segment Access Management documentation](/docs/segment-app/iam/) for more details.
23
23
24
24
## Step 1: Create a new Developer space
@@ -46,13 +46,13 @@ To learn more, visit [Connect production sources](/docs/unify/quickstart/#step-3
46
46
47
47
## Step 4: Check your profile data
48
48
49
-
Once the replay finishes, you can see the data replayed into Engage using the Profile Explorer. Visit the [Unify Onboarding Guide](/docs/unify/quickstart/#step-4-check-your-profile-data) for more info.
49
+
Once the replay finishes, you can see the data replayed into Engage using the Profile explorer. Visit the [Unify Onboarding Guide](/docs/unify/quickstart/#step-4-check-your-profile-data) for more info.
50
50
51
51
## Step 5: Create an Audience
52
52
53
-
You can build an audience using any source data that flows into your Engage space.
53
+
You can build an audience using any source data that flows into your Engage space.
54
54
55
-
In this step, use the Audience Builder UI to create an Audience using properties you're familiar with. For example, you might know the number of new website user signups in the last seven days, if you've connected your production website source to Engage.
55
+
In this step, use the Audience Builder UI to create an Audience using properties you're familiar with. For example, you might know the number of new website user signups in the last seven days, if you've connected your production website source to Engage.
Copy file name to clipboardExpand all lines: src/segment-app/iam/roles.md
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -24,7 +24,7 @@ The following roles are only available to Segment Business Tier accounts.
24
24
* Edit access to [End User Privacy Settings](/docs/privacy/user-deletion-and-suppression). Includes access to Data Privacy Agreement, and user suppression and deletion workflows.
25
25
***Scope:** Grants access to only End User Privacy Settings in the App.
26
26
27
-
#### Profiles Identity Admin
27
+
#### Unify Identity Admin
28
28
* Edit access to Identity settings in Unify.
29
29
***Scope:** Grants access to *all* Identity settings.
30
30
@@ -37,16 +37,16 @@ The following roles are only available to Segment Business Tier accounts.
37
37
* Edit access to assigned source(s), source settings, connected streaming destinations, schema, transformations, the source's [write key](/docs/connections/find-writekey/) and live data in the debugger.
38
38
***Scope:** Grants access to either: all current and future Sources, or only specific Sources, or Sources with a specific Label (BT only).
39
39
40
-
#### Profiles and Engage Admin
40
+
#### Unify and Engage Admin
41
41
* Edit access to Unify settings and if purchased, Engage Audiences, Traits, Journeys, Content, and settings.
42
42
***Scope:** Grants access to either: all current and future Spaces, or a specific list of Spaces, or Spaces with a specific Label (BT only).
43
43
44
44
45
-
#### Profiles and Engage Read-only
45
+
#### Unify and Engage Read-only
46
46
* Read-only access to Unify settings and if purchased, Engage audiences, traits, journeys, and content. Cannot download PII or edit settings in Unify or Engage.
47
47
***Scope:** Grants access to either: all current and future Spaces, or a specific list of Spaces, or Spaces with a specific Label (BT only).
48
48
49
-
#### Profiles Read-only, Engage User
49
+
#### Unify Read-only, Engage User
50
50
* Read-only access to Unify settings and if purchased, edit access to Engage audiences, traits, journeys, and content. Cannot download PII or edit settings in Unify or Engage.
51
51
***Scope:** Grants access to either: all current and future Spaces, or a specific list of Spaces, or Spaces with a specific Label (BT only).
Copy file name to clipboardExpand all lines: src/unify/identity-resolution/externalids.md
+5-2Lines changed: 5 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,9 +10,12 @@ redirect_from:
10
10
11
11
## Default externalIDs
12
12
13
-
The Identity Graph creates or merges profiles based on externalIDs. ExternalIDs will become the Identities attached to a User Profile in the User Explorer:
13
+
The Identity Graph creates or merges profiles based on externalIDs. ExternalIDs will become the identities attached to a user profile in the Profile explorer.
14
14
15
-

15
+
> success ""
16
+
> Navigate to **Unify > Profile explorer** to view identities attached to a profile, along with custom traits, event history, and more.
17
+
18
+

16
19
17
20
Segment automatically promotes the following traits and IDs in track and identify calls to externalIDs:
Copy file name to clipboardExpand all lines: src/unify/identity-resolution/identity-resolution-onboarding.md
+5-2Lines changed: 5 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,9 +11,12 @@ redirect_from:
11
11
> note ""
12
12
> **NOTE:** Workspace owners, administrators, and users with the Identity Admin role can edit Identity Resolution Settings.
13
13
14
-
Segment creates and merges user profiles based on a space's Identity Resolution configuration. Segment searches for identifiers such as `userId`, `anonymousId`, and `email` on incoming events and matches them to existing profiles or creates new profiles. These identifiers display in the Identities tab of a User Profile in the User Explorer:
14
+
Segment creates and merges user profiles based on a space's Identity Resolution configuration. Segment searches for identifiers such as `userId`, `anonymousId`, and `email` on incoming events and matches them to existing profiles or creates new profiles. These identifiers display in the Identities tab of a User Profile in the Profile explorer.
15
15
16
-

16
+
> success ""
17
+
> Navigate to **Unify > Profile explorer** to view identities attached to a profile, along with custom traits, event history, and more.
18
+
19
+

0 commit comments