Skip to content

Update api spec#32

Open
cbrinicombe13 wants to merge 10 commits intomainfrom
boosts
Open

Update api spec#32
cbrinicombe13 wants to merge 10 commits intomainfrom
boosts

Conversation

@cbrinicombe13
Copy link
Member

No description provided.

@cursor
Copy link

cursor bot commented Feb 8, 2026

You have run out of free Bugbot PR reviews for this billing cycle. This will reset on February 24.

To receive reviews on all of your PRs, visit the Cursor dashboard to activate Pro and start your 14-day free trial.

Comment on lines 180 to 182
Points boosts are multipliers that you can use to incentivise user actions in your product during a specific time period.

This section walks through how boosts work, and how you can use them to incentivise users to take actions within your application and increase retention and engagement.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Points boosts are multipliers that you can use to increase the number of points awarded to users during a specific time period.

This section explains how boosts work and how they can be used to increase your application's retention and engagement.

There are a few different ways you can use boosts in Trophy.

- **Global boosts** multiply points earned by all users during the boost window.
- **Scoped boosts** using [custom user attributes](/platform/users#custom-user-attributes) only multiply points earned by a particular user group with custom attribute values matching those set on the boost.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think we should explain these as a separate 'type' of boost, we don't call achievements with attributes filters 'scoped achievements', nor do we call leaderboards with a breakdown attribute 'scoped leaderboards'. The two types are global and user-specific, with the former optionally having a user attribute filter.

- **Scoped boosts** using [custom user attributes](/platform/users#custom-user-attributes) only multiply points earned by a particular user group with custom attribute values matching those set on the boost.
- **User-specific boosts** only multiply points earned by a single user within the boost window.

Typically, global boosts are used to increase platform-wide engagement during key calendar events like BFCM in e-commerce, New Year in fitness and exam season in ed-tech platforms.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

maybe write out BFCM for the uninitiated haha


Typically, global boosts are used to increase platform-wide engagement during key calendar events like BFCM in e-commerce, New Year in fitness and exam season in ed-tech platforms.

Conversely, scoped and user-specific boosts are commonly targeted at providing additional incentives to specific usage patterns that are leading to churn or disengagement.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Conversely, scoped and user-specific boosts are commonly used to provide additional incentives for users to take actions that are correlated with higher retention.

User-specific boosts can only be created programmatically through the [Admin API](/admin-api/endpoints/points/create-boosts).
</Note>

To create a points boost via the Trophy dashboard, follow the steps below.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

To create a global points boost in the Trophy dashboard, follow the steps below.

<Step title="Choose Name">
Choose a name for your boost that clearly describes what it's for. For example "2X Boost - All Users - Christmas 2026".
</Step>
<Step title="Set Multiplier">
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Set the multiplier

<Step title="Set Multiplier">
Set the numeric value that the boost will multiply points earned by. If you choose a decimal multiplier, you'll have the option to choose the [rounding behavior](#boost-rounding) the boost should use.
</Step>
<Step title="Set Boost Window">
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Set the boost window

<Step title="Set Boost Window">
Choose a start and (optionally) an end date for your boost. If you choose a future start date, Trophy will schedule the boost to go active on your chosen date. Similarly if you set an end date, Trophy will take care of stopping your boost for you.
</Step>
<Step title="Set Scope (Optional)">
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add attribute filters (optional)

</Frame>
</Step>
<Step title="Activate Boost">
Hit *Save Boost* and make your boost active when ready.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Click Save Boost to save your new boost to your account. The boost will be in the inactive state by default. To activate it, click the dropdown to the right of the boost name on the Boosts page and click Activate.

Comment on lines +258 to +259
Points boosts in Trophy stack through [multiplication](#boost-multipliers). This is to support allowing users to benefit from multiple boosts simultaneously.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this URL links to what we are already looking at no?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nearly, it's the section above but just added for consistency.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants