Skip to content

Commit b71ab31

Browse files
authored
Merge pull request #3124 from segmentio/Engage-Docs-Update
Engage Docs Update
2 parents 6d2010b + 9bef2aa commit b71ab31

File tree

3 files changed

+39
-21
lines changed

3 files changed

+39
-21
lines changed

src/engage/audiences/index.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,9 @@ See [Account-level Audiences](/docs/personas/audiences/account-audiences) for mo
5555

5656
## Connecting your Audience to a Destination
5757

58+
> warning "Audience Keys"
59+
> Avoid using the same Audience key twice, even if you've deleted the original Audience.
60+
5861
Once you have previewed your audience, you can choose to connect a destination, or simply keep the audience in Segment and download a csv. If you already have destinations set up in Segment, you can import the configuration from one of your existing sources to Personas. Note that you can only connect one destination configuration per destination type.
5962

6063
![](/docs/personas/images/audience_select_destination_card.png)
@@ -108,7 +111,10 @@ To edit a realtime Trait or Audience, follow these steps:
108111
3. Select the **Builder** tab and make your edits.
109112
4. Select **Save Audience** to confirm your edits.
110113

111-
Personas then processes your realtime Audience or Trait edits. Once Personas has finished incorporating your changes, you'll be able to access your updated Audience or Trait.
114+
Personas then processes your realtime Audience or Trait edits. While the edit task runs, the audience remains locked and you can't make further changes. Once Personas has finished incorporating your changes, you'll be able to access your updated Audience or Trait.
115+
116+
> warning ""
117+
> If your audience includes historical data (Historical Backfill is enabled), editing an audience creates a new backfill task. The backfill task, and therefore the edit task, take longer to process if the audience is connected to a destination with rate limits. Rate-limited destinations dictate how fast Personas can backfill. View a list of [rate-limited destinations](/docs/personas/using-personas-data/#rate-limits-on-personas-event-destinations).
112118
113119
## Accessing your Audiences using the Profiles API
114120

src/engage/profiles/computed-traits.md

Lines changed: 31 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ Account-level examples:
3636
- Total Logins by Account 30 Days
3737
- Emails Opened by Account 90 Days
3838

39-
![](images/1525835194991.png)
39+
![An event counter trait run over the course of a week](images/1525835194991.png)
4040

4141
### Aggregation
4242

@@ -50,27 +50,27 @@ Account-level use cases
5050
- Total Minutes Watched 30 Days
5151
- Avg Order Size Last 180 Days
5252

53-
![](images/1525835663131.png)
53+
![An aggregation trait run over the course of 90 days](images/1525835663131.png)
5454

5555
### Most Frequent
5656

57-
A most frequent user-level computed trait will return the **most common value** for an **event property**. This is helpful to create traits like `preferred_product_viewed` or `most_commonly_viewed_category` that tell you what a user's preferred product, or content category might be. Note that the most frequent computed trait requires the event property to have been tracked at least twice. In the case of a tie, we return the first alphabetical value. For account-level computed traits, you can also return the most frequent **user trait**. This is helpful when you want to determine which user has performed an event the most frequently. For example, you might to return the email of the user in an account most actively viewing your app.
57+
A most frequent user-level computed trait will return the **most common value** for an **event property**. This is helpful to create traits like `preferred_product_viewed` or `most_commonly_viewed_category` that tell you what a user's preferred product, or content category might be. Note that the most frequent computed trait requires the event property to have been tracked at least twice. In the case of a tie, Segment returns the first alphabetical value. For account-level computed traits, you can also return the most frequent **user trait**. This is helpful when you want to determine which user has performed an event the most frequently. For example, you might to return the email of the user in an account most actively viewing your app.
5858

5959
User-level examples:
6060
- Favorite Blog Post
6161
- Top Purchase Category
6262

63-
![](images/1525836239527.png)
63+
![A most frequent product-viewed trait](images/1525836239527.png)
6464

6565
Account-level examples:
6666
- Most frequent product viewed
6767
- Most active user
6868

69-
![](images/1542073415630.png)
69+
![A most frequent order-completed trait](images/1542073415630.png)
7070

7171
### First
7272

73-
The first user-level trait returns the first event property value we have seen. This is common for creating traits like `first_page_visited` based on the page name. For accounts, the first computed trait could also return a trait like `first_user_signup`, to calculate the first user to use your product.
73+
The first user-level trait returns the first event property value Segment has seen. This is common for creating traits like `first_page_visited` based on the page name. For accounts, the first computed trait could also return a trait like `first_user_signup`, to calculate the first user to use your product.
7474

7575
User-level examples:
7676
- First seen timestamp
@@ -80,23 +80,23 @@ Account-level examples:
8080
- First email opened
8181
- First user signup
8282

83-
![](images/1525836568474.png)
83+
![The first event-seen trait builder](images/1525836568474.png)
8484

8585
### Last
8686

87-
The last trait returns the last event property value we have seen. This is common for creating traits like `last_utm_campaign` to help you calculate last-touch attribution for paid advertising.
87+
The last trait returns the last event property value Segment has seen. This is common for creating traits like `last_utm_campaign` to help you calculate last-touch attribution for paid advertising.
8888

8989
User-level examples:
9090
- Last seen at
9191
- Last utm parameter
9292

93-
![](images/1525836818177.png)
93+
![The last event-seen trait builder](images/1525836818177.png)
9494

9595
Account-level examples:
9696
- Last unsubscribe timestamp
9797
- Last user active
9898

99-
![](images/1542073887657.png)
99+
![An account-level last page-viewed trait](images/1542073887657.png)
100100

101101
### Unique List
102102

@@ -107,7 +107,7 @@ Example use cases:
107107
- Unique categories
108108
- Unique games played
109109

110-
![](images/1525837083070.png)
110+
![The unique list trait builder](images/1525837083070.png)
111111

112112

113113
### Unique List Count
@@ -118,13 +118,13 @@ User-level examples:
118118
- Unique products viewed count
119119
- Unique categories count
120120

121-
![](images/1525837374378.png)
121+
![The unique list count builder](images/1525837374378.png)
122122

123123
Account-level examples:
124124
- Unique products viewed
125125
- Unique visitors count
126126

127-
![](images/1542074153487.png)
127+
![An account-level unique list trait](images/1542074153487.png)
128128

129129
## Conditions
130130

@@ -150,14 +150,26 @@ The following operators are available.
150150

151151
Personas sends user-level computed Traits to destinations using the [Identify call](/docs/connections/spec/identify/) for user traits, or using the [Track call](/docs/connections/spec/track/) for event properties. Segment includes the trait value and property in the identify and track calls.
152152

153-
For example, the name of a computed trait is added to the user profile as a trait, and the trait's value is set to the value of the computed trait. Segment sends an identify or track call when the trait is computed, depending on the destination configuration. If a computed trait counts the number of times a user visits your pricing page, and the user visits your pricing page five times, Segment sends an identify call with the property `pricing_page_visits: 5`.
153+
For example, the name of a computed trait is added to the user profile as a trait, and the trait's value is set to the value of the computed trait. Segment sends an identify or track call when the trait is computed, depending on the destination configuration. If a computed trait counts the number of times a user visits your pricing page, and the user visits your pricing page five times, Segment sends an identify call with the property `pricing_page_visits: 5`.
154154

155155
Learn more about [Computed trait generated events here](/docs/personas/using-personas-data/#computed-trait-generated-events). The trait name corresponds to the snake cased name that you see in the trait settings, for example `most_viewed_page_category`. See the [list of Personas-compatible destinations](/docs/personas/using-personas-data/#compatible-personas-destinations)
156156

157-
![](images/1525837601768.png)
157+
![Editing a computed trait's settings](images/1525837601768.png)
158158

159-
For account-level computed traits, you have the option to send either a [group](/docs/connections/spec/group/) call and/or [identify](/docs/connections/spec/identify/) call. Group calls will send one event per account, whereas identify calls will send an identify call for each user in the account. This means that even if a user hasn't performed an event, we will still set the account-level computed trait on that user. Because most marketing tools are still based at the user level, it is often important to map this account-level trait onto each user within an account. See [Account-level Audiences](/docs/personas/audiences/account-audiences) for more information.
159+
For account-level computed traits, you have the option to send either a [group](/docs/connections/spec/group/) call and/or [identify](/docs/connections/spec/identify/) call. Group calls will send one event per account, whereas identify calls will send an identify call for each user in the account. This means that even if a user hasn't performed an event, Segment will still set the account-level computed trait on that user. Because most marketing tools are still based at the user level, it is often important to map this account-level trait onto each user within an account. See [Account-level Audiences](/docs/personas/audiences/account-audiences) for more information.
160160

161+
## Editing Realtime Traits
162+
163+
Personas supports the editing of realtime Traits, which allows you to make nuanced changes to existing Traits in situations where cloning or building from scratch may not suit your use case.
164+
165+
To edit a realtime Trait, follow these steps:
166+
167+
1. In your Personas Space, select the **Computed Traits** tab.
168+
2. Select the realtime Trait you want to edit.
169+
3. Select the **Builder** tab and make your edits.
170+
4. Select **Save Computed Trait** to confirm your edits.
171+
172+
Personas then processes your Trait edits. While the edit task runs, the trait remains locked and you can't make further changes. Once Personas has finished incorporating your changes, you'll be able to access your updated Trait.
161173

162174
## Accessing your Computed Traits using the Profiles API
163175

@@ -184,17 +196,17 @@ returns:
184196

185197
You can read the [full Profile API docs](/docs/personas/profile-api/) to learn more.
186198

187-
## Downloading your Computed Trait as a CSV
199+
## Downloading your Computed Trait as a CSV file
188200

189201
You can download a copy of your trait by visiting the the computed trait overview page.
190-
![](images/trait_overview.png)
202+
![Downloading a CSV file of computed traits in Segment](images/trait_overview.png)
191203
Computed Trait CSVs are generated on demand. Before you can download the CSV, you will need to generate it. There are three different options for formatting:
192204
- **Unformatted:** Contains three columns. The first contains the user or account key, the second contains the trait value and the third is a JSON object containing the external IDs. Generating this CSV is by far the fastest of the three options. [Download example unformatted CSV](files/trait_csv_format_a.csv)
193205
- **Distinct columns for unique external IDs (with indexed columns for ID types with multiple values):** Contains the same first three columns as the unformatted CSV. Additional columns are added for each distinct external ID type. When a single row has more than one value for a given external ID type, for example a user with three email addresses, _additional columns with indexed headers are added_, (`email`, `email_1`, `email_2`). [Download example formatted CSV with indexed columns](files/trait_csv_format_b.csv)
194206
- **Distinct columns for unique external IDs (with additional rows for ID types with multiple values):** Contains the same first three columns as the unformatted CSV. Additional columns are added for each distinct external ID type. When a single row has more than one value for a given external ID type, for example a user with two email addresses, _additional rows are added with the first three columns repeated (user or account key, trait value and external IDs JSON)._ [Download example formatted CSV with additional rows](files/trait_csv_format_c.csv)
195207
<table>
196208
<tr>
197-
<td>![](images/large_trait_csv.png)</td>
209+
<td>![Handling large CSV file downloads](images/large_trait_csv.png)</td>
198210
<td width="45%">Generating a CSV can take a substantial amount of time for large traits (around 30 seconds for a formatted CSV with 1 million rows). For CSVs that are expected to take over 20 seconds, the Segment app displays an estimated generation time. After clicking Generate, it is recommended that you leave the modal and page open while the CSV is created.
199211
(If the trait recalculates between when you click Generate and when you download the file, you might want to regenerate the file. The CSV is a snapshot from when you clicked Generate, and could be outdated.)</td>
200212
</tr>

src/personas/computed-traits.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -198,7 +198,7 @@ You can read the [full Profile API docs](/docs/personas/profile-api/) to learn m
198198
## Downloading your Computed Trait as a CSV file
199199

200200
You can download a copy of your trait by visiting the the computed trait overview page.
201-
![Downloading a CSV file of computed traits in the Segment](images/trait_overview.png)
201+
![Downloading a CSV file of computed traits in Segment](images/trait_overview.png)
202202
Computed Trait CSVs are generated on demand. Before you can download the CSV, you will need to generate it. There are three different options for formatting:
203203
- **Unformatted:** Contains three columns. The first contains the user or account key, the second contains the trait value and the third is a JSON object containing the external IDs. Generating this CSV is by far the fastest of the three options. [Download example unformatted CSV](files/trait_csv_format_a.csv)
204204
- **Distinct columns for unique external IDs (with indexed columns for ID types with multiple values):** Contains the same first three columns as the unformatted CSV. Additional columns are added for each distinct external ID type. When a single row has more than one value for a given external ID type, for example a user with three email addresses, _additional columns with indexed headers are added_, (`email`, `email_1`, `email_2`). [Download example formatted CSV with indexed columns](files/trait_csv_format_b.csv)

0 commit comments

Comments
 (0)