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 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 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

Get user open challenge by ID

Post Streak Activity