# Trophy Docs

## Docs

- [Billing](https://docs.trophy.so/account/billing.md): Learn how Trophy controls costs by charging based on monthly active users.
- [Branding](https://docs.trophy.so/account/branding.md): Configure your logo and brand colors used across features built with Trophy.
- [Members](https://docs.trophy.so/account/members.md): Give team members access to Trophy and manage your account settings.
- [Overview](https://docs.trophy.so/account/overview.md): Learn how to manage your Trophy account.
- [Authentication](https://docs.trophy.so/admin-api/authentication.md): Integrate securely with the API using account-level API keys transmitted in the `X-API-KEY` header.
- [Client Libraries](https://docs.trophy.so/admin-api/client-libraries.md): Use Trophy's type-safe SDKs to integrate with the API.
- [Create attributes](https://docs.trophy.so/admin-api/endpoints/attributes/create-attributes.md): Create attributes.
- [Delete attributes](https://docs.trophy.so/admin-api/endpoints/attributes/delete-attributes.md): Delete attributes by ID.
- [Get an attribute](https://docs.trophy.so/admin-api/endpoints/attributes/get-an-attribute.md): Get an attribute by ID.
- [List attributes](https://docs.trophy.so/admin-api/endpoints/attributes/list-attributes.md): List attributes.
- [Update attributes](https://docs.trophy.so/admin-api/endpoints/attributes/update-attributes.md): Update attributes by ID.
- [Create leaderboards](https://docs.trophy.so/admin-api/endpoints/leaderboards/create-leaderboards.md): Create leaderboards. Maximum 100 leaderboards per request.
- [Delete leaderboards](https://docs.trophy.so/admin-api/endpoints/leaderboards/delete-leaderboards.md): Delete leaderboards by ID.
- [Get a leaderboard](https://docs.trophy.so/admin-api/endpoints/leaderboards/get-a-leaderboard.md): Get a leaderboard by ID.
- [List leaderboards](https://docs.trophy.so/admin-api/endpoints/leaderboards/list-leaderboards.md): List leaderboards.
- [Update leaderboards](https://docs.trophy.so/admin-api/endpoints/leaderboards/update-leaderboards.md): Update leaderboards by ID. Updating `status` behaves the same as activating, scheduling, deactivating, or finishing a leaderboard in the dashboard.
- [Create metrics](https://docs.trophy.so/admin-api/endpoints/metrics/create-metrics.md): Create metrics.
- [Delete metrics](https://docs.trophy.so/admin-api/endpoints/metrics/delete-metrics.md): Delete metrics by ID.
- [Get a metric](https://docs.trophy.so/admin-api/endpoints/metrics/get-a-metric.md): Get a metric by ID.
- [List metrics](https://docs.trophy.so/admin-api/endpoints/metrics/list-metrics.md): List metrics.
- [Update metrics](https://docs.trophy.so/admin-api/endpoints/metrics/update-metrics.md): Update metrics by ID.
- [Create points boosts](https://docs.trophy.so/admin-api/endpoints/points/create-boosts.md): Create points boosts.
- [Create points levels](https://docs.trophy.so/admin-api/endpoints/points/create-levels.md): Create points levels. Maximum 100 levels per request.
- [Create points systems](https://docs.trophy.so/admin-api/endpoints/points/create-points-systems.md): Create points systems. Optionally include sub-entities (levels, boosts, triggers) in each system payload to create them alongside the system.
- [Create points triggers](https://docs.trophy.so/admin-api/endpoints/points/create-points-triggers.md): Create points triggers in bulk. Maximum 100 triggers per request.
- [Delete points boosts](https://docs.trophy.so/admin-api/endpoints/points/delete-boosts.md): Delete multiple points boosts by ID.
- [Delete points levels](https://docs.trophy.so/admin-api/endpoints/points/delete-levels.md): Delete multiple points levels by ID.
- [Delete points systems](https://docs.trophy.so/admin-api/endpoints/points/delete-points-systems.md): Delete (archive) points systems by ID.
- [Delete points triggers](https://docs.trophy.so/admin-api/endpoints/points/delete-points-triggers.md): Delete (archive) points triggers by ID. Maximum 100 trigger IDs per request.
- [Get a points boost](https://docs.trophy.so/admin-api/endpoints/points/get-a-boost.md): Get a single points boost by ID.
- [Get a points level](https://docs.trophy.so/admin-api/endpoints/points/get-a-level.md): Get a single points level by ID.
- [Get a points system](https://docs.trophy.so/admin-api/endpoints/points/get-a-points-system.md): Get a points system by ID.
- [Get a points trigger](https://docs.trophy.so/admin-api/endpoints/points/get-a-points-trigger.md): Get a single points trigger by ID.
- [List points boosts](https://docs.trophy.so/admin-api/endpoints/points/list-boosts.md): List points boosts for a system.
- [List points levels](https://docs.trophy.so/admin-api/endpoints/points/list-levels.md): List points levels for a system.
- [List points systems](https://docs.trophy.so/admin-api/endpoints/points/list-points-systems.md): List points systems.
- [List points triggers](https://docs.trophy.so/admin-api/endpoints/points/list-points-triggers.md): List points triggers for a system.
- [Update points boosts](https://docs.trophy.so/admin-api/endpoints/points/update-boosts.md): Update multiple points boosts.
- [Update points levels](https://docs.trophy.so/admin-api/endpoints/points/update-levels.md): Update multiple points levels. Each item must include an ID. `key` cannot be changed.
- [Update points systems](https://docs.trophy.so/admin-api/endpoints/points/update-points-systems.md): Update points systems by ID.
- [Update points triggers](https://docs.trophy.so/admin-api/endpoints/points/update-points-triggers.md): Update points triggers in bulk. Maximum 100 triggers per request. Only provided fields are updated; omitted fields are preserved.
- [Create streak freezes for multiple users](https://docs.trophy.so/admin-api/endpoints/streaks/grant-freezes.md): Create streak freezes for multiple users.
- [Restore streaks for multiple users](https://docs.trophy.so/admin-api/endpoints/streaks/restore-streaks.md): Restore streaks for multiple users to the maximum previously achieved streak length found within the current restore window: the last 90 days for daily streaks, weekly periods starting with the week containing the start of the current calendar year for weekly streaks, and monthly periods starting at…
- [Introduction](https://docs.trophy.so/admin-api/introduction.md): Learn about the Trophy Admin API and how to use it to drive custom workflows using Trophy data.
- [Rate Limiting](https://docs.trophy.so/admin-api/rate-limiting.md): Learn about the Trophy API and request rate limiting.
- [Authentication](https://docs.trophy.so/api-reference/authentication.md): Integrate securely with the API using account-level API keys transmitted in the `X-API-KEY` header.
- [Client Libraries](https://docs.trophy.so/api-reference/client-libraries.md): Use Trophy's type-safe SDKs to integrate with the API.
- [Get all achievements and their completion stats](https://docs.trophy.so/api-reference/endpoints/achievements/all-achievements.md): Get all achievements and their completion stats.
- [Mark an achievement as completed](https://docs.trophy.so/api-reference/endpoints/achievements/mark-an-achievement-as-completed.md): Mark an achievement as completed for a user.
- [Get all leaderboards](https://docs.trophy.so/api-reference/endpoints/leaderboards/get-all-active-leaderboards.md): Get all leaderboards for your organization. Finished leaderboards are excluded by default.
- [Get a single leaderboard](https://docs.trophy.so/api-reference/endpoints/leaderboards/get-leaderboard.md): Get a specific leaderboard by its key.
- [Send a metric change event](https://docs.trophy.so/api-reference/endpoints/metrics/send-a-metric-change-event.md): Increment or decrement the value of a metric for a user.
- [Get a points system with its triggers](https://docs.trophy.so/api-reference/endpoints/points/get-points.md): Get a points system with its triggers.
- [Get boosts for a points system](https://docs.trophy.so/api-reference/endpoints/points/get-points-boosts.md): Get all global boosts for a points system. Finished boosts are excluded by default.
- [Get level summary for a points system](https://docs.trophy.so/api-reference/endpoints/points/get-points-level-summary.md): Get a breakdown of the number of users at each level in a points system.
- [Get levels for a points system](https://docs.trophy.so/api-reference/endpoints/points/get-points-levels.md): Get all levels for a points system.
- [Get a breakdown of users by points](https://docs.trophy.so/api-reference/endpoints/points/get-points-summary.md): Get a breakdown of the number of users with points in each range.
- [Get top users by streak length](https://docs.trophy.so/api-reference/endpoints/streaks/get-streak-rankings.md): Get the top users by streak length (active or longest).
- [Get the streak lengths of a list of users](https://docs.trophy.so/api-reference/endpoints/streaks/get-streaks.md): Get the streak lengths of a list of users, ranked by streak length from longest to shortest.
- [Create a new user](https://docs.trophy.so/api-reference/endpoints/users/create-a-user.md): Create a new user.
- [Get a summary of metric events over time](https://docs.trophy.so/api-reference/endpoints/users/get-a-single-metric-event-summary-for-a-user.md): Get a summary of metric events over time for a user.
- [Get a single metric for a user](https://docs.trophy.so/api-reference/endpoints/users/get-a-single-metric-for-a-user.md): Get a user's progress against a single active metric.
- [Get a single user](https://docs.trophy.so/api-reference/endpoints/users/get-a-single-user.md): Get a single user.
- [Get a user's achievements](https://docs.trophy.so/api-reference/endpoints/users/get-a-users-completed-achievements.md): Get a user's achievements.
- [Get a user's leaderboard data](https://docs.trophy.so/api-reference/endpoints/users/get-a-users-leaderboard.md): Get a user's rank, value, and history for a specific leaderboard.
- [Get a user's points data](https://docs.trophy.so/api-reference/endpoints/users/get-a-users-points.md): Get a user's points for a specific points system.
- [Get a user's active points boosts](https://docs.trophy.so/api-reference/endpoints/users/get-a-users-points-boosts.md): Get active points boosts for a user in a specific points system. Returns both global boosts the user is eligible for and user-specific boosts.
- [Get a summary of points events over time](https://docs.trophy.so/api-reference/endpoints/users/get-a-users-points-summary.md): Get a summary of points awards over time for a user for a specific points system.
- [Get a user's streak status](https://docs.trophy.so/api-reference/endpoints/users/get-a-users-streak.md): Get a user's streak data.
- [Get a user's wrapped data](https://docs.trophy.so/api-reference/endpoints/users/get-a-users-wrapped.md): Get a user's year-in-review wrapped data.
- [Get all metrics for a user](https://docs.trophy.so/api-reference/endpoints/users/get-all-metrics-for-a-user.md): Get a single user's progress against all active metrics.
- [Get a user's preferences](https://docs.trophy.so/api-reference/endpoints/users/get-user-preferences.md): Get a user's notification preferences.
- [Identify a user](https://docs.trophy.so/api-reference/endpoints/users/identify-a-user.md): Identify a user.
- [Update a user](https://docs.trophy.so/api-reference/endpoints/users/update-a-user.md): Update a user.
- [Update a user's preferences](https://docs.trophy.so/api-reference/endpoints/users/update-user-preferences.md): Update a user's notification preferences.
- [Idempotency](https://docs.trophy.so/api-reference/idempotency.md): Prevent unintended side effects when retrying requests with idempotency controls built into the Trophy API and SDKs.
- [Introduction](https://docs.trophy.so/api-reference/introduction.md): Learn about the Trophy API and get started building your integration.
- [Rate Limiting](https://docs.trophy.so/api-reference/rate-limiting.md): Learn about the Trophy API and request rate limiting.
- [Engagement](https://docs.trophy.so/experimentation/engagement.md): Learn how to measure the impact of gamification on engagement
- [Overview](https://docs.trophy.so/experimentation/overview.md): Learn how to use Trophy to experiment with the gamification experience and increase retention and user engagement.
- [Retention](https://docs.trophy.so/experimentation/retention.md): Learn how to measure the impact of gamification on retention
- [Welcome to Trophy](https://docs.trophy.so/getting-started/introduction.md): Trophy documentation for gamification APIs, quickstart guides and tutorials.
- [Quick Start](https://docs.trophy.so/getting-started/quickstart.md): Get up and running with Trophy in under 10 minutes
- [How to Build a Gamified Fitness Tracker](https://docs.trophy.so/guides/gamified-fitness-platform.md): Learn how to build a Strava-like fitness app with Next.js, featuring multi-sport tracking, city-based leaderboards, and normalized XP progression.
- [Achievements](https://docs.trophy.so/platform/achievements.md): Learn how to use Achievements in a gamified product experience with Trophy.
- [Emails](https://docs.trophy.so/platform/emails.md): Learn how to use emails in a gamified product experience with Trophy.
- [Events](https://docs.trophy.so/platform/events.md): Events are data objects that represent individual user interactions against metrics in Trophy.
- [Leaderboards](https://docs.trophy.so/platform/leaderboards.md): Learn how to use Leaderboards in a gamified product experience with Trophy.
- [Metrics](https://docs.trophy.so/platform/metrics.md): Learn how to model user interactions using Trophy Metrics. Model any user interaction and trigger automated gamification flows with just a few lines of code.
- [Overview](https://docs.trophy.so/platform/overview.md): Learn the key concepts behind Trophy's gamification system.
- [Points](https://docs.trophy.so/platform/points.md): Learn how to build points-based systems using Trophy
- [Push Notifications](https://docs.trophy.so/platform/push-notifications.md): Learn how to use push notifications in a gamified product experience with Trophy.
- [Streaks](https://docs.trophy.so/platform/streaks.md): Learn how to use streaks in a gamified product experience with Trophy.
- [Users](https://docs.trophy.so/platform/users.md): Learn how to track interactions across your userbase using Trophy.
- [Achievement completed](https://docs.trophy.so/webhooks/events/achievements/achievement-completed.md): Triggered when a user completes an achievement.
- [Leaderboard changed](https://docs.trophy.so/webhooks/events/leaderboards/leaderboard-changed.md): Triggered when leaderboard rankings change.
- [Leaderboard finished](https://docs.trophy.so/webhooks/events/leaderboards/leaderboard-finished.md): Triggered when a run of a leaderboard finishes.
- [Leaderboard rank changed](https://docs.trophy.so/webhooks/events/leaderboards/leaderboard-rank-changed.md): Triggered when a user's leaderboard rank changes.
- [Leaderboard started](https://docs.trophy.so/webhooks/events/leaderboards/leaderboard-started.md): Triggered when a run of a leaderboard begins.
- [Points boost finished](https://docs.trophy.so/webhooks/events/points/points-boost-finished.md): Triggered when a points boost ends (its end time has been reached).
- [Points boost started](https://docs.trophy.so/webhooks/events/points/points-boost-started.md): Triggered when a points boost goes live (its start time has been reached).
- [Points changed](https://docs.trophy.so/webhooks/events/points/points-changed.md): Triggered when a user is awarded or loses points. This event is fired a maximum of once per user per points system per minute.
- [Points level changed](https://docs.trophy.so/webhooks/events/points/points-level-changed.md): Triggered when a user's level changes within a points system as a result of earning or losing points.
- [Streak extended](https://docs.trophy.so/webhooks/events/streaks/streak-extended.md): Triggered when a user extends an existing active streak.
- [Streak freeze consumed](https://docs.trophy.so/webhooks/events/streaks/streak-freeze-consumed.md): Triggered when a user consumes a streak freeze.
- [Streak freeze earned](https://docs.trophy.so/webhooks/events/streaks/streak-freeze-earned.md): Triggered when a user earns streak freezes.
- [Streak lost](https://docs.trophy.so/webhooks/events/streaks/streak-lost.md): Triggered when a user loses their streak.
- [Streak started](https://docs.trophy.so/webhooks/events/streaks/streak-started.md): Triggered when a user starts a streak.
- [Idempotency](https://docs.trophy.so/webhooks/idempotency.md): Learn how to ensure your webhook endpoints only process events once to prevent unintended side effects.
- [Introduction](https://docs.trophy.so/webhooks/introduction.md): Learn about webhooks in Trophy and how to use them to power custom gamification integrations.
- [Observability](https://docs.trophy.so/webhooks/observability.md): Learn how to monitor and diagnose issues with webhook delivery.
- [Quick Start](https://docs.trophy.so/webhooks/quickstart.md): Start receiving webhook events from Trophy in under 10 minutes.
- [Retries](https://docs.trophy.so/webhooks/retries.md): Learn how Trophy handles webhook retries with configured endpoints.
- [Security](https://docs.trophy.so/webhooks/security.md): Build secure webhook endpoints using webhook signature verification.

## OpenAPI Specs

- [application](https://docs.trophy.so/openapi/application.yml)
- [admin](https://docs.trophy.so/openapi/admin.yml)
- [openapi](https://docs.trophy.so/openapi.yml)