Get current mini-game and streak state
POST
/v1/users/mini-game-streak-stats
What this endpoint does
WARNING
customerSuccess permission. Do not expose the key in browser code, mobile bundles, URLs, logs, screenshots, or analytics.Quick start
{ "email": "member@example.com" }email is required, must be a valid email address, and is matched case-insensitively. The API key determines community scope; do not send a community ID.Authentication and permission
Authorization: Bearer <community-api-key>. The key must be active, must select the intended community, and must include customerSuccess. Keep it server-side. Missing or invalid authentication returns 401; a valid key without the permission returns 403 on this route.Complete examples
wheels: [] and streaks: []; it is still a successful read.Success and readback
data.wheels contains every active spin_the_wheel mini-game configured in the community. data.streaks contains the community's configured streaks. Array order is not a contract; match records by name.Wheel fields
| Field | Meaning |
|---|---|
name | Configured wheel name. Treat it as configuration, not a stable programmatic ID. |
spins | Count of currently available spin-inventory records. Used, expired, or removed spins are not counted. |
missionCleared | true only when the latest non-expired mission activity for that wheel is completed. It resets when the mission period expires. |
spinToday | true when at least one spin result exists for this wheel between 00:00:00.000 and 23:59:59.999 UTC today. |
currentStreak | Current stored wheel streak. Returns 0 when no wheel stats exist. |
Streak fields
| Field | Meaning |
|---|---|
name | Configured streak name. |
currentStreak | Current count stored for this streak; defaults to 0. |
missionCleared | Whether the most recent active, non-expired streak activity is completed. |
Empty and zero states
Errors and recovery
400: missing or invalid email.401: missing, invalid, or expired authentication.403: the key is valid but lacks customerSuccess.404: no user can be resolved for the supplied email.500: unexpected service failure.Retry safety
Idempotency-Key. Retrying does not consume spins or change streaks. The values are recalculated on every request, so a later successful retry may legitimately differ when a spin is earned, used, or expires between calls.Gotchas
spinToday uses the UTC day, not the user's or broker's local timezone.missionCleared, spinToday, spins, and currentStreak are independent signals.name.Next steps
1.
2.
name; do not depend on array position.3.
spin-earned, spin-used, spin-expired, and streak events.4.
5.
Request
Body Params application/jsonRequired
Responses
Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'https://api.returning.ai/v1/users/mini-game-streak-stats' \
--header 'Content-Type: application/json' \
--data-raw '{
"email": "member@example.com"
}'Response Response Example
200 - Success Example
{
"status": "success",
"message": "User mini game and streak stats fetched successfully",
"data": {
"wheels": [
{
"name": "Weekly rewards wheel",
"spins": 1,
"missionCleared": true,
"spinToday": false,
"currentStreak": 3
}
],
"streaks": [
{
"name": "Weekly activity streak",
"currentStreak": 3,
"missionCleared": true
}
]
}
}Modified at 2026-08-17 18:44:58