1. Streak
Game Loom
  • Game Loom
    • 👋 Welcome to Game Loom
  • Getting started
    • Introduction
    • 👤 Authentication
  • User Registration
    • Introduction
    • Get Countries
      GET
    • Get Cities
      GET
    • Single user registration
      POST
    • Bulk Register Users
      POST
  • Notifications
    • Overview
    • Receiving Event Notifications via Webhooks
    • Get All notifications for specific user
      GET
  • Rewards
    • Overview
    • Integrate with you reward system
    • Points
      • Record user point event
      • Get user points
      • Get Specific user point
    • Levels
      • Record user level event
      • Get user levels
      • Get Specific user level
    • Badges
      • Award badge to user
      • Get user badges
      • Get Specific user badge
  • Challenges (Gamification elements)
    • Introduction
    • Leaderboard
      • Get available leaderboards for user
      • Submit score to a leaderboard
      • Get user's leaderboard participation history
      • Get leaderboard details
      • Get leaderboard ranking
      • Get user's record for a leaderboard
      • Get user's entry history for a leaderboard
    • Survey
      • Overview
      • Get available surveys for user
      • Start a new survey participation
      • Get detailed user participation
      • Get user's survey participation history
      • Abandon survey participation
      • Save individual answer to survey question
      • Submit completed survey
      • Submit Survey with answers (One-Step Submission)
    • Quiz
      • Get available quizzes for user
      • Submit complete quiz answers
      • Get comprehensive user quiz history
      • Get comprehensive quiz attempt details
    • Open Challenge
      • Overview
      • Get available open challenges for user
      • Complete an open challenge
      • Get user's open challenge participation history
      • Get user open challenge by ID
    • Streak
      • Get User Streak Progress.
        GET
      • Post Streak Activity
        POST
    • Schemas
      • Survey Schame
  • MarketPlace
    • Overview
    • Marketplace
      • Browse available gifts for user
      • Get gift details
      • Redeem a gift
      • Get user's redemption history
    • Schemas
      • ProblemDetails
      • Pagination
  1. Streak

Get User Streak Progress.

Developing
GET
api/v1/streaks/{streakId}/user/{userKey}/progress
Returns the user's progress in a streak: all-time score, activity count, current period score, completion status, and progress percentage toward the score goal.

Request

Path Params

Query Params

Header Params

Responses

🟢200
application/json
Body

Request Request Example
Shell
JavaScript
Java
Swift
curl --location -g --request GET 'https://api-stg.98s.studio/api/v1/streaks/dade94ab-5646-496f-ba01-7cee002f5145/user/{{user-key}}/progress?fromDate=2026-04-25&toDate=2026-04-26' \
--header 'x-api-key: {{api-key}}'
Response Response Example
{"id":"dade94ab-5646-496f-ba01-7cee002f5145","name":"Streak one-multiple","status":"SCHEDULED","occurrence":"MONTHLY","scoreGoal":2,"startDate":"2026-04-30T21:00:00Z","endDate":"2026-05-31T20:59:00Z","totalScore":0,"totalActivityLogs":0,"currentPeriod":{"periodStart":"2026-04-01T00:00:00Z","periodEnd":"2026-04-30T00:00:00Z","score":0,"isPeriodEnd":false},"progressPercentage":0,"calendar":[{"periodStart":"2026-04-01T00:00:00","periodEnd":"2026-05-01T00:00:00","score":0,"status":"IN_PROGRESS"}]}
Modified at 2026-04-25 17:54:03
Previous
Get user open challenge by ID
Next
Post Streak Activity
Built with