Skip to content

Commit d610360

Browse files
Merge pull request #8 from trophyso/streak-email-docs
Add streak email docs
2 parents 7b3fad3 + 342a37a commit d610360

6 files changed

Lines changed: 35 additions & 12 deletions

File tree

65.8 KB
Loading
-18.1 KB
Loading
-70.4 KB
Binary file not shown.
41.9 KB
Loading

experimentation/trophy-impact-score.mdx

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,13 @@ icon: percent
77

88
## What Is The Trophy Impact Score?
99

10-
By default, Trophy only enrolls 90% of your users in any gamification emails. It leaves the other 10% out as a 'control cohort'.
10+
Trophy has a built-in A/B testing feature that allows you to test the impact of your gamification features on retention and engagement.
11+
12+
Through manipulating the [Control Ratio](#customizing-the-control-ratio), you can assign a certain percentage of your users to a 'control cohort'. Each new user that you tell Trophy about will be automatically assigned to the control cohort or not based on this setting.
13+
14+
Trophy then exposes the `control` attribute through the [GET user API](/api-reference/endpoints/users/get-a-single-user#response-control) to allow developers to hide gamification UI and features from users in the control cohort.
15+
16+
Similarly, if you use the [Emails](/platform/emails) feature, Trophy only sends emails to users who are not in the control cohort.
1117

1218
Trophy then automatically tracks the 14-day retention of the two cohorts and compares them, resulting in the Trophy Impact Score.
1319

@@ -28,11 +34,13 @@ The Trophy Impact Score reflects the percentage difference in 14-day retention b
2834
cohort.
2935
</Tip>
3036

31-
## Customizing the control ratio
37+
## Customizing The Control Ratio
38+
39+
By default, Trophy will use a 90/10 ratio of non-control/control users. However, you can customize this as you wish.
3240

3341
If you'd prefer to use a different ratio of control to non-control users then you can do so on the [Integration](https://app.trophy.so/integration) page.
3442

35-
Use the slider to change the percentage of your userbase that will be set as control users and opted out of gamification emails.
43+
Use the slider to change the percentage of your userbase that will be set as control users and opted out of gamification features.
3644

3745
<Frame>
3846
<video

platform/emails.mdx

Lines changed: 24 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,9 @@ Trophy can send automated emails to users based on key triggers without requirin
99

1010
## Types Of Emails
1111

12-
Trophy supports 3 types of emails, each of which is designed to suit a common scenario in building gamification experiences.
12+
Trophy supports 4 types of emails, each of which is designed to suit a common scenario in building gamification experiences.
1313

14-
All emails are optional, but all three can be used simultaneously and can be controlled from the [Emails](https://app.trophy.so/emails/configure) page in the Trophy dashboard.
14+
All emails are optional, but all four can be used simultaneously and can be controlled from the [Emails](https://app.trophy.so/emails/configure) page in the Trophy dashboard.
1515

1616
<Frame>
1717
<img height="200" noZoom src="../assets/platform/emails/email_types.png" />
@@ -37,6 +37,10 @@ Emails are sent as follows:
3737
- After 14 days of inactivity
3838
- After 30 days of inactivity
3939

40+
### Streak Reminder Emails
41+
42+
Streak reminder emails are automatically sent to users up to 4 hours before they are about to lose their [Streak](/platform/streaks).
43+
4044
## Designing Emails
4145

4246
Trophy has a fully-featured block-based email builder that allows you to design templates, controlling all email copy and subject lines. Within the [Emails](https://app.trophy.so/emails/configure) page you can create templates and assign them to the 3 different [Email Types](#types-of-emails).
@@ -530,30 +534,41 @@ Additionally, the editor support pluralization. In the below example we show dif
530534

531535
## Email Customization
532536

533-
On the [Configure](https://app.trophy.so/emails/configure) page you'll find a couple of different settings you can control to manage email design across your Trophy account.
537+
### Aggregation Period
534538

535539
<Frame>
536540
<img
537541
height="200"
538542
width="75%"
539543
noZoom
540-
src="../assets/platform/emails/email_customization_settings.png"
544+
src="../assets/platform/emails/aggregation_period_setting.png"
541545
/>
542546
</Frame>
543547

544-
### Aggregation Period
548+
The aggregation period controls the timeframe over which blocks like the [Progress Chart](#progress-chart) display usage. It also controls the frequency at which [Recap Emails](#recap-emails) are sent. Possible values are daily, weekly, monthly or yearly.
545549

546-
The aggregation period controls the timeframe over which blocks like the [Progress Chart](#progress-chart) track usage. It also controls the frequency at which [Recap Emails](#recap-emails) are sent. Possible values are daily, weekly, monthly or yearly.
550+
Head into the [Integration](https://app.trophy.so/integration) page to manage this setting.
547551

548552
### Font Style
549553

550-
Changes the font style used across all email templates. Additional styles are pulled from your Trophy account's [Branding](https://app.trophy.so/branding) settings.
554+
On the [email configure page](https://app.trophy.so/emails/configure), you'll find a setting to change the font style used in all emails.
555+
556+
<Frame>
557+
<img
558+
height="200"
559+
width="75%"
560+
noZoom
561+
src="../assets/platform/emails/aggregation_period_setting.png"
562+
/>
563+
</Frame>
564+
565+
Other email styles are pulled from your Trophy account's [Branding](https://app.trophy.so/branding) settings.
551566

552567
## Send-time Optimization
553568

554-
By default all emails sent by Trophy are sent at **17:00PM ET**, however sending emails to users based on their local timezone usually results in better engagement rates.
569+
In most cases, emails sent by Trophy are sent at **17:00PM ET**, however sending emails to users based on their local timezone usually results in better engagement rates.
555570

556-
That's why if through [User Identification](/platform/users#param-tz) you specify a timezone for each user, Trophy will optimize the send-time for you.
571+
That's why if through [User Identification](/platform/users#param-tz) you specify a timezone for each user, Trophy will optimize the send-time for you by sending emails to users at 17:00PM in their local timezone.
557572

558573
## Setting up Emails
559574

0 commit comments

Comments
 (0)