Skip to content

Commit 5309874

Browse files
authored
Merge branch 'master' into develop
2 parents af76762 + b9ce397 commit 5309874

File tree

5 files changed

+121
-26
lines changed

5 files changed

+121
-26
lines changed

src/connections/functions/environment.md

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,61 @@ If you're editing an existing function, you can **Save** changes without changin
5252

5353
When you deploy your destination function in your workspace, you fill out the settings on the destination configuration page, similar to how you would configure a normal destination.
5454

55+
## Functions Versioning
5556

57+
With Functions Versioning, you can access a complete change history for each source or destination function. View version history and creation details, then use a unified or split display to compare code and restore previous versions of a function.
58+
59+
> info "Functions Versioning in beta"
60+
> Functions Versioning is in beta, and Segment is actively working on this feature. Some functionality may change before it becomes generally available. Versioning is disabled in workspaces where you deploy source functions with multiple instances. [Contact Segment](https://segment.com/help/contact/){:target="_blank"} with any feedback or questions.
61+
62+
63+
### View and compare version history
64+
65+
To view the version history of a function:
66+
1. Navigate to **Connections > Catalog > Functions**.
67+
2. Select your source or destination function.
68+
3. Select **Edit Function**, then click **Version history**.
69+
70+
Select previous versions to compare code using a *unified* or *split* view. With the split view, Segment displays the latest version on the left and the version you've selected on the right.
71+
72+
> success ""
73+
> Unified and split compare screens are read-only. While you can copy code, you can't make changes directly from these screens.
74+
75+
#### `LATEST` and `DEPLOYED` versions
76+
77+
In the Version History panel, Segment displays `LATEST` and `DEPLOYED` labels that represent a function version state. You'll see the `LATEST` version at the top.
78+
79+
Segment labels a version as the `LATEST` when:
80+
- You save a change to the function source code, but don't deploy the function at the same time.
81+
- You [restore a previous version](#restore-a-previous-version) from your function's version history.
82+
83+
The `DEPLOYED` version is the function version that's currently deployed.
84+
85+
### Restore a previous version
86+
87+
To restore a previous function version:
88+
89+
1. Select the function you want to restore.
90+
2. Click **Restore this version**.
91+
- Segment creates a duplicate of the selected version and labels it as the `LATEST` version.
92+
3. Click **Restore** on the confirmation screen.
93+
4. To deploy the restored version, click **Save and Deploy** on the Source Code screen.
94+
95+
### Use Versioning with Segment's Public API
96+
97+
You can use Functions Versioning with Segment's [Public API](https://docs.segmentapis.com/tag/Functions){:target="_blank"} to retrieve version history records and source code, as well as to restore previous versions.
98+
99+
Here are some Public API use case examples:
100+
101+
**Get Version history**: Use the `/versions` endpoint to retrieve a list of version records and metadata of a certain page size. You can also use this endpoint to get version source code for a given version ID.
102+
103+
**Restore a previous version**: Use the `/restore` endpoint to restore a previous function version. This creates a new version with the same source as the version you are restoring.
104+
105+
**Create or update versions**: Create or update a function to add a version record and save the source code.
106+
107+
**Deploy a function**: Use the Public API to deploy a function. After you deploy, Segment marks the function version as `DEPLOYED`. Learn more about function version states [here](#latest-and-deployed-versions).
108+
109+
View Segment's [Public API](https://docs.segmentapis.com/tag/Functions){:target="_blank"} docs for more information on how to use Functions Versioning with the Public API.
56110

57111
## Functions permissions
58112

src/engage/journeys/build-journey.md

Lines changed: 22 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -67,12 +67,12 @@ You may find that you need to make changes to a published Journey, like adding n
6767

6868
### Pausing and resuming a Journey
6969

70-
Pausing a published Journey prevents new users from joining your Journey. Users already in the Journey, however, will continue their progress.
70+
Pausing a published Journey prevents new users from joining your Journey. Users already in the Journey, however, will continue their progress.
7171

7272
Follow these steps to pause a Journey:
7373

74-
1. Select the **Journeys** tab within your Engage space.
75-
2. Select the **More Options** icon next to the Journey you want to pause.
74+
1. Select the **Journeys** tab within your Engage space.
75+
2. Select the **More Options** icon next to the Journey you want to pause.
7676
3. From the dropdown menu, select **Pause Entry**.
7777
4. A modal window appears. Select **Pause Entry** again to confirm.
7878

@@ -81,14 +81,14 @@ Follow these steps to pause a Journey:
8181
8282
### Resuming a Journey
8383

84-
You can resume new user entries to a paused Journey at any time. 
84+
You can resume new user entries to a paused Journey at any time.
8585

86-
After you resume a Journey, users who meet the Journey's entry conditions will join the Journey. New users will not enter the Journey, however, if they met its entry conditions while it was paused. 
86+
After you resume a Journey, users who meet the Journey's entry conditions will join the Journey. New users will not enter the Journey, however, if they met its entry conditions while it was paused.
8787

8888
Follow these steps to resume entry to a paused Journey:
8989

90-
1. Select the **Journeys** tab within your Engage space.
91-
2. Select the **More Options** icon next to the Journey you want to resume.
90+
1. Select the **Journeys** tab within your Engage space.
91+
2. Select the **More Options** icon next to the Journey you want to resume.
9292
3. From the dropdown menu, select **Resume Entry**.
9393
4. A modal window appears. Select **Resume Entry** again to confirm.
9494

@@ -114,7 +114,17 @@ No new users enter archived Journeys, and progress stops for any users already i
114114
> success "Compute credits"
115115
> Steps in archived Journeys don't count towards your compute credits.
116116
117-
## Journey re-entry
117+
## Journey exits and re-entry
118+
119+
### Journey exits
120+
121+
You can apply exit settings to both single entry and re-entry Journeys. Users who exit a Journey leave all Journey steps and Destinations.
122+
123+
Configure exit settings during initial Journey setup by enabling exit settings and entering the number of days that should pass before users exit the Journey. Journeys exits users once this time passes.
124+
125+
If you don't apply exit settings to a Journey, users will remain in the Journey indefinitely.
126+
127+
### Journey re-entry
118128

119129
The Journeys re-entry setting allows users to repeat Journeys they've already exited. Common use cases for Journeys re-entry include the following:
120130

@@ -124,14 +134,12 @@ The Journeys re-entry setting allows users to repeat Journeys they've already ex
124134

125135
### Exit and re-entry times
126136

127-
Users who exit a Journey leave all Journey steps and Destinations. To let users re-enter a Journey they've exited, you'll need to enable two Journeys settings:
137+
To let users re-enter a Journey they've exited, you'll need to enable two Journeys settings:
128138

129139
- Journeys exit time
130140
- Journeys re-entry time
131141

132-
Users must first exit a Journey before re-entering. You can configure exit settings during initial Journey setup by enabling exit settings and entering the number of days that should pass before users exit the Journey. Journeys exits users once this time passes, allowing users to re-enter once they meet the Journey's entry conditions again.
133-
134-
You can then configure re-entry time by hour, day, or week. An exited user won't re-enter the same Journey until the re-entry time has passed. Re-entry time begins once a user exits the Journey.
142+
Journeys exits users based off of the exit time you configure. Users can re-enter the Journey once they meet the Journey's entry condition again and your defined re-entry time has passed. You can configure re-entry time by hour, day, or week. Re-entry time begins once a user exits the Journey.
135143

136144
Suppose, for example, you enable re-entry for an abandoned cart campaign. You set exit to seven days and re-entry to 30 days. A user who abandons their cart will progress through the Journey and exit no later than seven days after entering. Once 30 days after exit have passed, the user can re-enter the Journey.
137145

@@ -157,11 +165,11 @@ When you've finished creating your Journey, click **Save as Draft** in the botto
157165

158166
### About published Journeys
159167

160-
Keep the following considerations in mind when working with a published Journey:
168+
Keep the following in mind when working with a published Journey:
161169

162170
- It may take up to three hours for Journeys to compute user counts after publication.
163171
- You can edit a Journey's name, description, and Destination steps.
164172
- You can't add, edit, or delete other steps in the Journey.
165173
- Once Journeys computes and displays user counts, you'll see the list of users at each step of the Journey.
166174
- Click a user profile to see the Journey list to which they belong.
167-
- Journeys sends and updates data to Destinations in real-time.
175+
- Journeys sends and updates data to Destinations in real-time.
Binary file not shown.
Lines changed: 39 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,12 @@
11
---
2-
title: Journey Level Analytics
2+
title: Journeys Analytics
33
redirect_from:
44
- '/personas/journeys/journeys-analytics'
55
---
66

7-
With Journey Level Analytics, you can gain insight into the overall performance of an individual Journey.
7+
Segment maintains analytics for each Journey and its individual steps. As a result, you can view both granular and high-level performance metrics that give you insight into your Journeys.
88

9-
## About Journey Level Analytics
10-
11-
> info ""
12-
> This feature is available in beta.
9+
## Journey-Level Analytics
1310

1411
Journeys Level Analytics is a collection of statistics that can help you assess how a Journey is performing.
1512

@@ -23,23 +20,28 @@ Follow these steps to view the Analytics for a specific Journey:
2320
2. Select a Journey from the Journeys list.
2421
3. The Analytics tiles display as part of the Journey's overview.
2522

26-
![An in-app screenshot of Journeys Level Analytics](images/journeys_analytics_tiles.png "Journeys Level Analytics tiles")
23+
> info ""
24+
> Journeys in draft status don’t display Analytics.
2725
28-
## Available Journeys Analytics statistics
26+
## Journey-Level Analytics statistics
2927

30-
The following table shows the three statistics available for a Journey:
28+
The following table shows the statistics available for a Journey:
3129

3230
| Statistic | Description |
3331
| ----------- | ----------------------------------------------------------------------------- |
34-
| Entries | The total number of users who entered your Journey |
32+
| Entered | The total number of users who entered your Journey |
3533
| In progress | The total number of users who have entered the Journey without yet exiting it |
34+
| Completed | The total number of users who entered the Journey and reached any final step |
3635
| Exits | The total number of users who have exited the Journey |
3736

38-
Using the date picker, you can view a Journey's analytics over a specific period of time.
37+
> info ""
38+
> Completed and exits are mutually exclusive.
39+
40+
Use the date picker to view a Journey's analytics over a specific time frame in any 180 day period.
3941

4042
The following table shows descriptions of the time frames you can select:
4143

42-
| Time frame | Description (based on UTC) |
44+
| Time frame | Description (based on UTC) |
4345
| ----------------- | ---------------------------------------------------------- |
4446
| Today | Today, beginning at midnight |
4547
| Yesterday | The day before today |
@@ -48,3 +50,28 @@ The following table shows descriptions of the time frames you can select:
4850
| Last 90 days | The past 90 days, not including today |
4951
| Last 180 days | The past 180 days, not including today |
5052
| Custom date range | The period between two dates, including the selected dates |
53+
54+
## Step-Level Analytics
55+
56+
Displayed with each step of your Journey, Step-Level Analytics shows you how many users made it to the step you’re viewing. You can use this data to gain context for how users flow through your Journey.
57+
58+
### Changing the calculation percentage
59+
60+
With Step-Level Analytics, you can configure two settings that give you granular insight into each step’s performance:
61+
62+
- **Previous step** or **entry step**, which calculates the displayed percentage based on either the number of users in the entry step or the number of users in the previous step
63+
- **Total** or **unique users**, which lets you change the displayed percentage to account for re-entry
64+
65+
#### Previous step or entry step
66+
67+
By default, Engage calculates an individual step’s analytics as a percentage of the number of users in the previous step. However, you can also view step analytics as a percentage of the initial number of users in the Journey’s entry step.
68+
69+
For example, suppose your Journey’s entry step contained 100 users, and 50 proceeded to the next step. For both calculation options, Engage would display **50% and 50** for the next step. If 25 users from the second step reached step three, however, Engage would display **50% and 25** for previous-step based calculations but **25% and 25** for entry-step based calculations.
70+
71+
To change this base percentage, select **Calculate % based on**, then select **Entry step** or **Previous step**.
72+
73+
#### Total or unique users
74+
75+
If you’ve enabled re-entry for your Journey, you can also configure Step-Level Analytics to calculate the step’s percentage based on unique or total users. Selecting **Unique** generates a percentage based on unique users, while **Total** includes users who have re-entered the Journey.
76+
77+
For more information on re-entry settings in Journeys, view [Journey re-entry](/docs/engage/journeys/build-journey/#journey-re-entry).

src/engage/journeys/key-terms.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,3 +55,9 @@ Keep the following terms in mind as you begin to explore Journeys.
5555
| Delay | No audience. Segment appends the wait duration as a condition to the following step's audience. |
5656
| T/F split | The split's resulting conditions contain two mutually exclusive audiences. The split node itself has no audience. |
5757
| Multi-branch splits | The split's resulting conditions contain audiences. The split node itself has no audience. |
58+
59+
## Analytics
60+
61+
| Metric | Definition |
62+
| ------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- |
63+
| Entry | When a user enters a Journey for the first time or re-enters a Journey after exiting; excludes users who re-enter a Journey without exiting. |

0 commit comments

Comments
 (0)