1. Streaks & Mini Games
Returning.AI
  • Getting Started
  • Users
    • User directory and provisioning
    • Get Users with Filters
      POST
    • Create New User
      POST
    • Get User Data
      POST
    • Manage User Account
      POST
    • Get User Milestones
      POST
    • Update User Data, Identifier, And Roles
      POST
    • Update User XP and Currency
      POST
  • Messaging
    • Agent messaging workflow
    • Get Messages
      GET
    • Send Message
      POST
    • Reply Message
      POST
    • React Message
      POST
    • Upload message images
      POST
  • Gamification
    • Leaderboards
      • Leaderboards
      • List leaderboards with pagination
      • Create a new leaderboard
      • Update an existing leaderboard
      • Get a single leaderboard by ID
      • Delete a leaderboard
    • Streaks & Mini Games
      • Mini-game State and History
      • List user streak logs
        GET
      • List mini-game logs by user email
        POST
      • Get current mini-game and streak state
        POST
      • Update user spin-wheel information
        POST
    • Referral
      • Referral Program Integration
      • Get referral programs
      • Get user's referral summary
    • Rolling Data
      • Get Daily Calculation Data
      • Get Rolling Calculation Data
    • Match Predictions
    • Get tier configuration
      GET
    • Get daily user XP and coin changes
      POST
    • Search user gamification logs
      POST
    • Get user activity stats
      POST
  • Rewards & Redemptions
    • Store catalog to redemptions
    • Update redemption order status or refund
    • List redemption orders by user email
    • List redemption statuses
    • Get redemption status by ID
    • List redemption orders by community
    • Create redemption order status
    • Get redemption order status history
  • Chart Analysis
    • Create Analysis
    • Get Analysis
    • Update Analysis
    • Delete Analysis
    • List Analyses
    • Append Drawings
  • Bulk Operations
    • Bulk user updates
    • List bulk update jobs
    • Get bulk update job status
    • Get bulk update job details
    • Bulk update users from CSV
    • Bulk update premium currency from CSV
  • Channels
    • Iframe
    • List integration channels
  • Events
    • Outgoing webhooks
      • Encryption
      • User Joins Server
      • User Visits server
      • New Message Posted Anywhere
      • New Message Posted To channel
      • Purchased Store Item
    • Incoming webhooks
      • API Keys & Encryption
      • Send message into channels
      • Update Custom User Fields
      • Update In-game currency
  • Widgets
    • Authenticated Widgets
    • Public widgets
    • Channels
    • Leaderboard
    • Milestone
    • Socials
    • Store
  • Community Analytics
    • Get Loyalty Overview
    • Get Phone Verification Contacts
  • Store
    • Store catalog
    • Purchase History
      • Update redemption instructions or voucher details
    • Categories
      • List Store categories
      • Create Store category
      • Get Store category by ID
      • Update Store category
      • Delete Store category
    • Products
      • List products
      • Update products in bulk
      • Create products in bulk
      • Create product with vouchers
      • Read product
      • Update product and append vouchers
      • Delete product
    • Redemption-transaction
      • Get redemption transaction detail
    • Get Store configuration
    • Update Store configuration
  • Community
    • Community directory and appearance
    • Appearance
      • Update community theme colors
      • Update community bot profile
      • Update community URL metadata
      • Update community name and URL
    • Community Users
      • Get community users
      • Get user
    • Create community
  • API Keys
    • API key lifecycle
    • Community API Keys
      • Create API key
      • Read API keys
      • Delete API key
      • Update API key
    • User API Keys
      • List user API keys
      • Create user API key
      • Update user API key
      • Delete user API key
      • Get current API key information
  • User Fields
    • User field definitions and history
    • User Field History
      • Get all user field histories in a community
      • Get user field histories for a specific field
      • Get user field histories for a specific user
      • Get user field histories of specific user field and user
      • Update A User Field Value
      • Deprecated Field-First History Write
      • Deprecated Field-First History Read
    • Get A User Field Definition
    • Update A User Field Definition
    • Create A User Field Definition
    • Delete A User Field Definition
    • List User Field Definitions
  • Legacy
    • Servers
      • Create server
      • List servers
      • Update server metadata
    • Bulk Operations
      • Bulk import users from CSV
    • Authentication
      • Secure Auth
      • Register user with password
      • Verify user email
      • Log in user with password
    • Badges
      • List badges
      • Create badge
      • Update badge
      • Delete badge
      • Remove badge from user
      • Award badge to user
    • Messaging
    • Roles & Permissions
      • List server roles
      • Create role
      • Update role
      • Delete role
      • List user roles
      • Add role to user
      • Remove role from user
    • Users
      • Get user
      • Upload user avatar
    • Channels
      • Create channel
      • Update channel
      • Delete channel
    • API Keys
      • List integration API keys
      • Create integration API key
      • Delete integration API key
      • Update integration API key
  1. Streaks & Mini Games

List user streak logs

GET
/v1/streak-logs

What this endpoint does#

Lists streak log rows for the API key's community. Use it after current mini-game and streak state when you need history rather than the live counters.
It does not change streaks. It does not return wheel spin inventory. An unknown email is 404, not an empty list.
INFO
Workflow
Authenticate with getStreakLogs → GET /v1/streak-logs or ?user=<email> → read data.data and data.pagination → if the email is unknown, stop and look the member up.

Quick start#

Omit user to read the community-scoped default page.

Authentication and permission#

Send Authorization: Bearer <COMMUNITY_API_KEY>. Required permission: getStreakLogs (UI: Get Streak Logs). Keep the key server-side.

Complete examples#

Default page (200). GET /v1/streak-logs with no query returns status: success and data.success: true, with data.data and pagination.
Existing member, no rows (200). ?user=<existing email> returns 200 with an empty data array when there is no history.
Unknown email (404). ?user=missing-user@example.com returns { "status": "error", "message": "User not found" }.
Treat emails as synthetic.

Success and readback#

HTTP 200. Envelope is { status: "success", data: { success, pagination, data } }.
data.data is an array of log rows. Empty data with total: 0 means no rows matched, not that the route failed.
This is a read. Repeat the same request to refresh.
CHECK
Empty is not missing
A 200 with data: [] for a known email means this community has no streak-log rows for that member. Confirm the email with POST /v1/users/info before treating the member as unknown.

Errors and recovery#

StatusWhenRecovery
404 User not founduser is a well-formed email that does not resolve in this communityLook up the member, then retry. Do not treat this as an empty history.
401Missing or invalid Bearer tokenAdd a valid community key with getStreakLogs.

Retry safety#

TIP
Exact retry
This GET does not write streak state. Retry timeouts and 500 with bounded backoff. Do not retry 404 User not found without changing user.

Gotchas#

Unknown email → 404. Known email with no activity → 200 empty. Those are different.
Use this for streak history. Use /v1/users/mini-game-streak-stats for current spins and streak counters.

Next steps#

Get current mini-game and streak state
Read live spin and streak counters for the same email.

Request

Query Params

Responses

🟢200OK
application/json
Request completed successfully.
Bodyapplication/json

🟠400Bad Request
🟠401Unauthorized
🟠404Record Not Found
🔴500Server Error
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --globoff 'https://adss-integration.returning.ai/apis/v1/streak-logs?user=undefined&streak_action=undefined&streak_name=undefined&streak_activity=undefined&date[gte]=undefined&date[lte]=undefined&time[gte]=undefined&time[lte]=undefined&sortBy=undefined&sortOrder=undefined&limit=undefined&page=undefined'
Response Response Example
200 - Example 1
{}
Modified at 2026-08-19 03:28:49
Previous
Mini-game State and History
Next
List mini-game logs by user email
Built with