Skip to content

Commit 8da330a

Browse files
committed
Compute status bar initial draft
1 parent 610b267 commit 8da330a

File tree

2 files changed

+46
-2
lines changed

2 files changed

+46
-2
lines changed

src/engage/audiences/computed-traits.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -171,6 +171,8 @@ To edit a real-time Trait, follow these steps:
171171

172172
Engage then processes your Trait edits. While the edit task runs, the trait remains locked and you can't make further changes. Once Engage has finished incorporating your changes, you'll be able to access your updated Trait.
173173

174+
You can use the Trait Overview page to view Trait details and compute status. For real-time Traits, click **Refresh Trait** to see the current number of users with the Trait. Learn more about [compute statuses](#understanding-compute-times) for Traits and Audiences.
175+
174176
## Accessing your Computed Traits using the Profiles API
175177

176178
You can access your computed traits using the Profile API by querying the `/traits` endpoint. For example, you can query for the `emails_opened_last_30_days` with the following GET request:

src/engage/audiences/index.md

Lines changed: 44 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -88,6 +88,46 @@ Because a number of factors (like system load, backfills, or user bases) determi
8888

8989
As a result, **Segment recommends waiting at least 24 hours for an Audience to finish computing** before you resume working with the Audience.
9090

91+
From the Audience Overview page, you can view Audience details including the current compute status or progress bar for real-time and batch Audiences.
92+
93+
> info ""
94+
> Engage only displays a progress bar when you're creating new Audiences or Traits.
95+
96+
### Refresh real-time Audiences and Traits
97+
98+
For real-time Audiences or Traits, click **Refresh Audience** or **Refresh Trait** to update all users, status, and compute progress. Engage refreshes real-time Audiences and Traits approximately every 10 minutes.
99+
100+
### Audience and Trait compute statuses
101+
102+
Engage displays the following compute statuses for real-time and batch Audiences and Traits.
103+
104+
#### Real-time Audience or Trait
105+
106+
| Computation Status | Description |
107+
|---------------------------|----------------------------|
108+
| Preparing | Engage is preparing the computation. |
109+
| Computing | Engage is computing the Audience or Trait. |
110+
| Live | The Audience or Trait is live with the most recent data. |
111+
| Disabled | The real-time Audience or Trait is disabled. |
112+
| Failed | The computation was cancelled or failed to compute. Please contact [Segment support](https://segment.com/help/contact/){:target="_blank"}. |
113+
114+
115+
#### Batch Audience or Trait
116+
117+
> info ""
118+
> Engage updates batch Audiences and Traits approximately once every hour.
119+
120+
121+
| Computation Status | Description |
122+
|---------------------------|------------------------------|
123+
| Preparing | Engage is preparing the batch computation. |
124+
| Computing | Engage is computing the batch Audience or Trait. |
125+
| Live | The batch computation is up-to-date with the most recent data, based on the most recent sync cadence. |
126+
| Not Computing | The audience is awaiting the destination to be connected. You'll see this status when there are no destinations connected and `Compute without connected destinations` isn't selected. |
127+
| Disabled | The batch Audience or Trait is disabled. |
128+
| Failed | The batch computation was cancelled or failed to compute. Please contact [Segment support](https://segment.com/help/contact/){:target="_blank"}. |
129+
130+
91131
## Real-time compute compared to batch
92132

93133
Real-time Compute allows you to update traits and Audiences as Segment receives new events. Real-time Compute unlocks exciting use cases:
@@ -108,7 +148,9 @@ To create a new Audience:
108148

109149
3. To preview your Audience, select **Select Destinations**, then select **Review & Create**.
110150

111-
By default, Segment queries all historical data to set the current value of the computed trait and Audience. You can uncheck **Historical Backfill** to compute values for the Audience or trait without using this data. With this disabled, the trait or Audience only uses the data that arrives after you created it.
151+
By default, Segment queries all historical data to set the current value of the computed trait and Audience. Backfill computes historical data up to the point of audience creation. After audience creation, Segment computes traits and audiences in real-time. You can uncheck **Include Historical Data** to compute values for the Audience or trait without historical data. With backfill disabled, the trait or Audience only uses the data that arrives after you create it.
152+
153+
After you create your Audience, Engage displays a confirmation screen along with an estimated time of completion.
112154

113155
Use the Audience Explorer to see users or accounts that enter the Audience. Segment displays the Audience as computing until at least one user or account enters.
114156

@@ -127,7 +169,7 @@ To edit a realtime Trait or Audience, follow these steps:
127169
3. Select the **Builder** tab and make your edits.
128170
4. Select **Save Audience** to confirm your edits.
129171

130-
Engage 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 Engage has finished incorporating your changes, you'll be able to access your updated Audience or Trait.
172+
Engage 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 Engage has finished incorporating your changes, you'll be able to access your updated Audience or Trait. You can use the Overview page to view user details, refresh real-time Audiences, and view the current [compute status](#).
131173

132174
> warning ""
133175
> 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 Engage can backfill. View a list of [rate-limited destinations](/docs/engage/using-engage-data/#rate-limits-on-engage-event-destinations).

0 commit comments

Comments
 (0)