- Get user analytics (Admin only)
Returns aggregated user statistics including total users, active users, new users, transaction metrics, campaign claims, redemptions, and engagement rate. Supports date range filtering. Requires admin authentication.
User analytics request with date range filters
Filters to scope which users/activity to include in analytics
{ "businessId": "biz-uuid-123" }
Start date for filtering activity and new users (ISO 8601 format). Filters transactions, claims, redemptions, and user creation dates.
- Mock serverhttps://docs.pers.ninja/_mock/swagger/analytics/users
- https://api.pers.ninja/v2https://api.pers.ninja/v2/analytics/users
curl -i -X POST \
https://docs.pers.ninja/_mock/swagger/analytics/users \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{}'User analytics successfully retrieved
Total number of registered users (all-time, no date filter applied). Includes all non-deleted users regardless of activity.
Number of active users - users with ≥1 successful transaction (status=succeeded), completed claim (status=COMPLETED), or completed redemption (status=COMPLETED) within the specified date range. If no date range provided, counts users with any activity ever.
Number of new users created within the specified date range (filtered by user.createdAt). If no date range provided, equals totalUsers.
Average transactions per user across entire user base (total successful transactions in date range ÷ total users). Only counts transactions with status=succeeded, excludes REDEMPTION_SPEND and REDEMPTION_RECEIVE types to prevent double-counting.
Average amount per transaction (total transaction volume ÷ transaction count). Only includes successful transactions (status=succeeded) in date range.
Total transaction volume - sum of all successful transaction amounts (status=succeeded) in date range. Excludes REDEMPTION_SPEND and REDEMPTION_RECEIVE types.
Total completed claims in the date range. Only counts claims with status=COMPLETED.
Average claims per user across entire user base (total completed claims in date range ÷ total users). Only counts claims with status=COMPLETED.
Total completed redemptions in the date range. Only counts redemptions with status=COMPLETED.
Average redemptions per user across entire user base (total completed redemptions in date range ÷ total users). Only counts redemptions with status=COMPLETED.
Total mint transactions in the date range. Only counts successful mint transactions (status=SUCCEEDED or BROADCASTED, type=MINT).
Average mints per user across entire user base (total mints in date range ÷ total users).
Total transfer transactions in the date range. Only counts successful transfer transactions (status=SUCCEEDED or BROADCASTED, type=TRANSFER).
Average transfers per user across entire user base (total transfers in date range ÷ total users).
Total burn transactions in the date range. Only counts successful burn transactions (status=SUCCEEDED or BROADCASTED, type=BURN).
Average burns per user across entire user base (total burns in date range ÷ total users).
Average transactions per active user (total successful transactions in date range ÷ active users in date range). Provides more accurate engagement metric than averageTransactionsPerUser by excluding inactive users.
Average claims per active user (total completed claims in date range ÷ active users in date range). Shows claim activity concentrated among engaged users.
Average redemptions per active user (total completed redemptions in date range ÷ active users in date range). Shows redemption activity concentrated among engaged users.
Average mints per active user (total mints in date range ÷ active users in date range).
Average transfers per active user (total transfers in date range ÷ active users in date range).
Average burns per active user (total burns in date range ÷ active users in date range).
User engagement rate as percentage (activeUsers ÷ totalUsers × 100). Indicates what percentage of all registered users had activity in the date range.
{ "totalUsers": 10523, "activeUsers": 3241, "newUsers": 156, "averageTransactionsPerUser": 12.5, "averageTransactionAmount": 45.67, "totalTransactionVolume": 56789.12, "totalClaims": 1523, "averageClaimsPerUser": 3.2, "totalRedemptions": 892, "averageRedemptionsPerUser": 1.8, "totalMints": 1250, "averageMintsPerUser": 1.2, "totalTransfers": 890, "averageTransfersPerUser": 0.8, "totalBurns": 523, "averageBurnsPerUser": 0.5, "averageTransactionsPerActiveUser": 15.3, "averageClaimsPerActiveUser": 4.7, "averageRedemptionsPerActiveUser": 2.1, "averageMintsPerActiveUser": 1.5, "averageTransfersPerActiveUser": 1.1, "averageBurnsPerActiveUser": 0.8, "engagementRate": 30.79, "periodBreakdown": [ { … } ], "metadata": { "dateRange": { … } } }