1. Gamification
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
      • List mini-game logs by user email
      • Get current mini-game and streak state
      • Update user spin-wheel information
    • 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
      PUT
    • List redemption orders by user email
      POST
    • List redemption statuses
      POST
    • Get redemption status by ID
      POST
    • List redemption orders by community
      POST
    • Create redemption order status
      POST
    • Get redemption order status history
      POST
  • 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. Gamification

Get user activity stats

POST
/v1/users/activity/stats

What this endpoint does#

Returns recent activity totals (messages, replies, reactions, socials) for one member over a day range.
It does not change XP or coins. It is not streak or wheel state.
INFO
Workflow
Resolve the member with Get User Data → POST /v1/users/activity/stats with identifier and identifier_type → use daily XP and coin changes for a specific date.

Quick start#

identifier_type is email or userId (numeric platform id). userID is rejected.

Authentication and permission#

Send Authorization: Bearer <COMMUNITY_API_KEY>. Required permission: getUserStats. Keep the key server-side.

Complete examples#

Email or numeric userId (200). message is User gamification stats fetched successfully. data includes user_id, range.start_date, range.end_date, totals (messages, replies, reaction, socials), and daily_stats[] with per-day counts.
Wrong enum (400). "identifier_type": "userID" returns Get user activity stats endpoint validation error. detail.identifier_type: Invalid enum value. Expected 'userId' | 'email', received 'userID'.
Empty body (400). detail.identifier: Required and detail.identifier_type: Required.
Treat identifiers as synthetic. Zero totals mean no activity in range, not a missing user.

Success and readback#

HTTP 200. Repeat the same POST to refresh. This is a read.

Errors and recovery#

StatusWhenRecovery
400 invalid identifier_typeuserID or other spellingSend email or userId.
400 required fieldsMissing identifier / identifier_typeSend both.
401Missing or invalid tokenAdd a valid community key with getUserStats.

Retry safety#

TIP
Exact retry
This POST is a read. Retry timeouts with bounded backoff. Repeating it does not write activity.

Gotchas#

Use userId, not userID.
For spin eligibility use current mini-game and streak state, not this summary.
reaction is the totals field name (singular).

Next steps#

Get daily user XP and coin changes
Read the XP and coin row for one date after these activity totals.

Request

Body Params application/json

Examples

Responses

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

🟠400Bad Request
🟠401Unauthorized
🟠403Forbidden
🟠409
🔴500Server Error
Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'https://adss-integration.returning.ai/apis/v1/users/activity/stats' \
--header 'Content-Type: application/json' \
--data-raw '{
    "identifier": "email1@test.com",
    "identifier_type": "email",
    "days": 30
}'
Response Response Example
200 - Success Example
{
    "status": "success",
    "message": "User gamification stats fetched successfully",
    "data": {
        "user_id": "188055",
        "range": {
            "start_date": "2025-08-18",
            "end_date": "2025-08-18"
        },
        "totals": {
            "messages": 0,
            "replies": 1,
            "reaction": 0,
            "socials": 0
        },
        "daily_stats": [
            {
                "date": "2025-08-18",
                "messages": 0,
                "replies": 1,
                "reaction": 0,
                "socials": 0
            }
        ]
    }
}
Modified at 2026-08-19 13:44:18
Previous
Search user gamification logs
Next
Store catalog to redemptions
Built with