Skip to main content

Overview

Build loyalty programs that reward user engagement through:
  • Quest-based point accumulation
  • Leaderboard-driven competition
  • User progress tracking via rankings
  • Sprint-specific campaigns

Understanding Loyalty Points

Quest Points System

Each quest can award loyalty points to participants:
Response:

Get User Points via Leaderboard

Basic Implementation

Find User Points

Get Quest Points Information

Sprint-Based Programs

Sprint vs Overall Comparison

Sprint Management: Sprint information must come from external sources as sprint management is not available through this API.

Compare User Progress

User Dashboard Pattern

Create User Dashboard

Quest Integration

Track Quest Completion

Common Integration Patterns

Points-Based Access Control

Achievement Thresholds

Usage Examples

Basic User Profile

Quest Rewards Preview

Achievement System

Best Practices

  1. Search Optimization: Limit user search to 20-50 pages max for UI responsiveness
  2. Caching: Cache user positions for 5-10 minutes to reduce API calls
  3. Error Handling: Handle cases where users are not found in rankings
  4. Performance: Consider showing approximate positions rather than exact searches
  5. User Experience: Clearly indicate when users are not yet ranked

Limitations & Workarounds

Current Limitations

  1. No Direct User Lookup: Must search through leaderboard pages
  2. Search Performance: Finding users can require multiple API calls
  3. No Sprint Management: Sprint IDs come from external sources
  1. Efficient Search: Implement reasonable search limits
  2. Caching Strategy: Cache user positions for short periods
  3. User Communication: Set expectations about search time
  4. Achievement Systems: Define point thresholds instead of exact rankings

Points Integration Patterns

  • New User Onboarding: Show potential points from available quests
  • Progress Tracking: Regular user position checks (respect rate limits)
  • Achievement Systems: Define point thresholds (100, 500, 1000, etc.)
  • Access Control: Points-based feature unlocking
  • Quest Recommendations: Suggest high-value quests based on current points

Next Steps