API ReferenceOrganisation Management
Admin platform analytics (Admin only)
Comprehensive real-time analytics across all platform dimensions: users, organisations, KYC, verifications, transactions, wallets, and API keys. Includes today / this-week / this-month growth breakdowns and aggregate financial volumes.
GET
/v1/organisation-management/analyticsAuthorization
bearer AuthorizationBearer <token>
In: header
Response Body
application/json
curl -X GET "https://example.com/v1/organisation-management/analytics"{ "success": true, "statusCode": 200, "message": "Request processed successfully", "timestamp": "2025-10-20T16:30:00.000Z", "path": "/v1/auth/register", "data": { "generatedAt": "2019-08-24T14:15:22Z", "overview": { "totalOrganisations": 1000, "totalUsers": 1005, "totalVerifications": 8700, "totalTransactions": 9300, "totalWalletBalance": 285000000, "totalDepositVolume": 95000000, "verificationSuccessRate": 94.25 }, "users": { "total": 1005, "byStatus": { "pending": 120, "active": 850, "suspended": 30, "deleted": 5 }, "newToday": 8, "newThisWeek": 42, "newThisMonth": 180 }, "organisations": { "total": 1000, "bySignupType": { "standalone": 740, "tenant": 260 }, "newToday": 5, "newThisWeek": 30, "newThisMonth": 120 }, "kyc": { "total": 1000, "byStatus": { "pending": 40, "submitted": 80, "underReview": 60, "approved": 700, "tenantApproved": 50, "rejected": 45, "resubmissionRequired": 25 }, "approvalRate": 75 }, "verifications": { "total": 8700, "byType": { "nin": 8200, "bvn": 300, "links": 150, "other": 50 }, "byStatus": { "pending": 20, "processing": 10, "success": 8200, "failed": 400, "expired": 70 }, "bySource": { "web": 3000, "sdk": 4500, "api": 1200 }, "newToday": 50, "newThisWeek": 320, "newThisMonth": 1400, "successRate": 94.25 }, "transactions": { "total": 9300, "byType": { "deposit": 500, "withdrawal": 20, "payment": 8700, "refund": 15, "reversal": 5, "fee": 30, "transfer": 10 }, "byStatus": { "pending": 12, "processing": 8, "success": 9100, "failed": 120, "abandoned": 40, "reversed": 5, "expired": 15 }, "volume": { "total": 125000000, "deposits": 95000000, "payments": 30000000 }, "newToday": 60, "newThisWeek": 380, "newThisMonth": 1600, "revenueToday": 450000, "revenueThisWeek": 3200000, "revenueThisMonth": 12500000 }, "wallets": { "total": 1000, "byStatus": { "active": 970, "suspended": 15, "frozen": 10, "closed": 5 }, "totalBalance": 285000000, "averageBalance": 285000 }, "apiKeys": { "total": 1000, "byType": { "test": 400, "live": 600 }, "byStatus": { "active": 850, "revoked": 100, "expired": 50 } } }}