Skip to content

Commit 30c092d

Browse files
authored
Merge pull request #5719 from segmentio/style-updates
Update Unify and Engage FAQs
2 parents 3b84be2 + 4010438 commit 30c092d

File tree

10 files changed

+51
-59
lines changed

10 files changed

+51
-59
lines changed

src/engage/faqs.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Engage Frequently Asked Questions
2+
title: Engage FAQs
33
plan: engage-foundations
44
redirect_from:
55
- '/personas/faqs'

src/engage/journeys/faq-best-practices.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -65,37 +65,37 @@ Follow these best practices to test your journeys:
6565
- For early version journeys, scaffold Send to Destination steps without connecting to your production advertising or messaging destinations.
6666
- Verify individual users' progress through the Journey in the Profile explorer view.
6767

68-
## Frequently asked questions
68+
## FAQs
6969

70-
### How often do Journeys run?
70+
#### How often do Journeys run?
7171

7272
Journeys run in real-time, like real-time Audiences in Engage. This means that users will progress through Journeys as Segment receives new events.
7373

74-
### Can a user re-enter a Journey?
74+
#### Can a user re-enter a Journey?
7575

7676
Yes. Users must first exit a Journey, however, before entering it again. To learn more about Journey re-entry, read the [Journey re-entry section](/docs/engage/journeys/build-journey/#journey-re-entry) of the [Build a Journey](/docs/engage/journeys/build-journey/) page.
7777

78-
### What destinations does Journeys support?
78+
#### What destinations does Journeys support?
7979

8080
Journeys supports all Engage destinations, including Destination Functions. Read more in Send data to destinations.
8181

82-
### What are the reporting capabilities of Journeys?
82+
#### What are the reporting capabilities of Journeys?
8383

8484
When building a Journey, if you check **Use historical data**, you can see the estimated number of users in the initial cohort.
8585

8686
Once published, Journeys displays the number of users are in each step of the Journey at any given time.
8787

88-
### How are users sent to downstream destinations?
88+
#### How are users sent to downstream destinations?
8989

9090
The data type you send to a destination depends on whether the destination is an Event Destination or a List Destination.
9191

92-
### Which roles can access Journeys?
92+
#### Which roles can access Journeys?
9393
For Engage customers, users with either the Engage User or Engage Admin roles can create, edit, and delete journeys. Users with the Engage Read-only role are restricted to view-only access.
9494

95-
### Why am I seeing duplicate entry or exit events?
95+
#### Why am I seeing duplicate entry or exit events?
9696

9797
Journeys triggers audience or trait-related events for each email `external_id` on a profile. If a profile has two email addresses, you'll see two Audience Entered and two Audience Exited events for each Journey step. Journeys sends both email addresses to downstream destinations.
9898

99-
### How quickly do user profiles move through Journeys?
99+
#### How quickly do user profiles move through Journeys?
100100

101101
It may take up to five minutes for a user profile to enter each step of a Journey, including the entry condition. For Journey steps that reference a batch audience or SQL trait, Journeys processes user profiles at the same rate as the audience or trait computation. Visit the Engage docs to [learn more about compute times](/docs/engage/audiences/#understanding-compute-times).

src/engage/trait-activation/id-sync.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ With Customized setup, you can choose which identifiers you want to map downstre
6262
- You can only select a maximum of three identifiers with an `All` strategy.
6363

6464

65-
## Frequently asked questions
65+
## FAQs
6666

6767
#### What's the difference between Trait Enrichment and ID Sync?
6868

src/engage/trait-activation/trait-enrichment.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -125,7 +125,7 @@ For best results with Trait Enrichment, Segment recommends:
125125
- Using Trait Enrichment with new audiences.
126126
- Using smaller audiences for real-time use cases, as data delivery is slower for large audiences.
127127

128-
## Frequently asked questions
128+
## FAQs
129129

130130
#### What's the difference between Trait Enrichment and ID Sync?
131131

src/engage/user-subscriptions/subscription-groups.md

Lines changed: 13 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -108,37 +108,34 @@ To set susbcription groups with the Identify call, you'll need to include a key-
108108
}
109109
```
110110

111-
## Frequently asked questions
111+
## FAQs
112+
113+
#### How many subscription groups can I have?
112114

113-
{% faq %}
114-
{% faqitem How many subscription groups can I have? %}
115115
Your Engage space includes up to 25 subscription groups.
116-
{% endfaqitem %}
117116

118-
{% faqitem Can I use subscription groups with templates I've already built? %}
117+
#### Can I use subscription groups with templates I've already built?
118+
119119
No. Templates you've previously created aren't compatible with subscription groups. To use subscription groups, you'll need to create new templates that include new unsubscribe and manage preference links.
120-
{% endfaqitem %}
121120

122-
{% faqitem What happens if I delete a subscription group? %}
121+
#### What happens if I delete a subscription group?
122+
123123
If you delete a subscription group, Engage will still maintain the preferences of the group's end users.
124-
{% endfaqitem %}
125124

126-
{% faqitem What subscription group events does the Engage Channels Source send? %}
127-
The [Engage Events Source](/docs/connections/sources/catalog/cloud-apps/engage-events/) tracks four subscription group events: `Email Unsubscribed`, `Email Group Unsubscribed`, `Channel Subscription Updated`, and `Group Subscription Updated`.
125+
#### What subscription group events does the Engage Channels Source send?
128126

129-
{% endfaqitem %}
127+
The [Engage Events Source](/docs/connections/sources/catalog/cloud-apps/engage-events/) tracks four subscription group events: `Email Unsubscribed`, `Email Group Unsubscribed`, `Channel Subscription Updated`, and `Group Subscription Updated`.
130128

131-
{% faqitem How can users opt back in if they've unsubscribed from all groups? %}
129+
#### How can users opt back in if they've unsubscribed from all groups?
132130
If a user unsubscribes from all of your subscription groups, they'll need to re-subscribe by explicitly opting back in to each group.
133-
{% endfaqitem %}
134131

135-
{% faqitem Do subscription preference links work in test emails? %}
132+
#### Do subscription preference links work in test emails?
133+
136134
Yes. Test emails include fully functional unsubscribe and subscription preference links. If a test email recipient unsubscribes using a test email, Segment updates that user's subscription state. <br><br>
137135

138136
Test emails temporarily override an email subscription state. This means that an unsubscribed email address can receive a test email but won't receive regular email campaigns from which they've unsubscribed.
139-
{% endfaqitem %}
140137

141-
{% faqitem Should I follow any conventions when naming a subscription group? %}
138+
#### Should I follow any conventions when naming a subscription group?
142139

143140
Yes. Keep the following table in mind when you name a subscription group:
144141

@@ -151,6 +148,3 @@ Yes. Keep the following table in mind when you name a subscription group:
151148
| Spaces in Group Names | Spaces aren't allowed at the beginning and/or end of the Group name |
152149
| Unsupported characters for Group Names | `!@#$%^&*()_+\-=\[\]{};':"\\|,.<>\/?` |
153150
| Unsupported accent characters for Group Names | `á, é, í, ó, ú, à, è, ì, ò, ù, ë, ï, ã` |
154-
{% endfaqitem %}
155-
156-
{% endfaq %}

src/unify/Traits/predictions/using-predictions.md

Lines changed: 21 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -70,49 +70,47 @@ Predictions may not be as beneficial in the following situations:
7070
- **When you sell limited but highly-priced items**, like enterprise software, complex medical machines, and so on; this also applies if you're in the B2B sector.
7171
- **When you don't yet have enough data**; your model could produce errors if, for example, your target is too new and lacks sufficient data. Waiting a month could allow Segment to gather more predictive data.
7272

73-
## Frequently asked questions
73+
## FAQs
74+
75+
#### What type of machine learning model do you use?
7476

75-
{% faq %}
76-
{% faqitem What type of machine learning model do you use? %}
7777
Segment uses a binary classification model that uses decision trees.
78-
{% endfaqitem %}
7978

80-
{% faqitem What level of confidence can I have in my predictions? %}
79+
#### What level of confidence can I have in my predictions?
80+
8181
Once Segment creates your prediction, you can check the model statistics page, where Segments shows you how the model was created. Segment also maintains automated systems that monitor model performance and will alert you if your model is not predictive.
82-
{% endfaqitem %}
8382

84-
{% faqitem How long do predictions take to create? %}
83+
#### How long do predictions take to create?
84+
8585
Trait creation depends on the amount of data, but Segment expects predictions to be completed in around 24 hours. For larger customers, however, this could take 48 hours. Predictions shows a status of `In Progress` while computing; Segment updates this status when customers are scored.
86-
{% endfaqitem %}
8786

88-
{% faqitem What are AUC, log loss, and lift quality? %}
87+
#### What are AUC, log loss, and lift quality?
88+
8989
These data science statistics measure the effectiveness of Segment's predictions when tested against historical data. For more information, refer to [ROC Curve and AUC](https://developers.google.com/machine-learning/crash-course/classification/roc-and-auc){:target="_blank"}, [The Lift Curve in Machine Learning](https://howtolearnmachinelearning.com/articles/the-lift-curve-in-machine-learning/){:target="_blank"}, and [Intuition behind log-loss score](https://towardsdatascience.com/intuition-behind-log-loss-score-4e0c9979680a){:target="_blank"}.
90-
{% endfaqitem %}
9190

92-
{% faqitem What is the Prediction Quality Score? %}
91+
#### What is the Prediction Quality Score?
92+
9393
The Prediction Quality Score factors AUC, log loss, and lift quality to determine whether Segment recommends using the prediction. A model can have a score of Poor, Fair, Good, or Excellent.
94-
{% endfaqitem %}
9594

96-
{% faqitem How do you store trait values? %}
95+
#### How do you store trait values?
96+
9797
The created trait value represents the user's percentile cohort. This value refreshes every seven days. If you see `0.85` on a user's profile, this means the user is in the 85th percentile, or the top 15% for the prediction.
98-
{% endfaqitem %}
9998

100-
{% faqitem How frequently do you re-train the model? %}
99+
#### How frequently do you re-train the model?
100+
101101
Segment rebuilds the machine learning model every 30 days.
102-
{% endfaqitem %}
103102

104-
{% faqitem How frequently do you update trait values? %}
103+
#### How frequently do you update trait values?
104+
105105
Every seven days.
106-
{% endfaqitem %}
107106

108-
{% faqitem How many predictions can I have? %}
107+
#### How many predictions can I have?
108+
109109
You get five predictions as part of Engage Foundations or Unify Plus. To purchase more predictions, reach out to your CSM.
110-
{% endfaqitem %}
111110

112-
{% faqitem Are there any known Predictions limitations? %}
111+
#### Are there any known Predictions limitations?
112+
113113
Yes. Keep the following in mind when you work with Predictions:
114114

115115
- **Predictions made for more than 100 million users will fail.** Segment recommends making predictions only for non-anonymous users, or, as an alternative, use the Starting Cohort to narrow down the audience for which you want to make a prediction.
116116
- **Predictions may not work as intended if you track more than a thousand unique events in your workspace.** If this applies to your use case, [contact Segment Support](https://segment.com/help/contact/){:target="_blank"} for help with removing unused events, which will allow you to create predictions.
117-
{% endfaqitem %}
118-
{% endfaq %}

src/unify/faqs.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Unify Frequently Asked Questions
2+
title: Unify FAQs
33
plan: unify
44
---
55

src/unify/identity-resolution/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,9 +26,9 @@ Identity Resolution sits at the core of Segment. The Identity Graph merges the c
2626
4. **Maintains persistent ID** - multiple external IDs get matched to one persistent ID
2727

2828

29-
## Frequently asked questions
29+
## FAQs
3030

31-
### Can I use the Profile API on the client-side?
31+
#### Can I use the Profile API on the client-side?
3232
For security reasons, Segment requires that the [Profile API](/docs/unify/profile-api/) only be used server-side. The Profile API allows you to look up data about any user given an identifier (for example, email, `anonymousId`, or `userId`) and an authorized access secret. While this enables powerful personalization workflows, it could also let your customers' data fall into the wrong hands if the access secret were exposed on the client.
3333

3434
Instead, by creating an authenticated personalization endpoint server-side backed by the Profile API, you can serve up personalized data to your users without the risk of their information falling into the wrong hands.

src/unify/linked-profiles/linked-events.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -152,7 +152,7 @@ After you’ve added Enrichments, test and save your enrichments.
152152
> warning ""
153153
> At this time, when you select mappings or test events, you won’t see enrichment data. Enrichment data is only available with real events.
154154
155-
## Frequently asked questions
155+
## FAQs
156156

157157
#### What data warehouse permissions does Segment require?
158158

src/unify/profiles-sync/sample-queries.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -154,7 +154,7 @@ INNER JOIN ps_materialize.id_graph
154154

155155
This query works with any Trait or Audience membership, whether computed in Engage or instrumented upstream.
156156

157-
## Frequently asked questions
157+
## FAQs
158158

159159
#### Can I view Engage Audience membership and Computed Trait values in my Warehouse?
160160

0 commit comments

Comments
 (0)