API for iblai
API Reference//
- analytics_users_details_retrieve
Get Content Analytics
Get Content Details
analytics_financial_retrieve
analytics_financial_details_retrieve
analytics_financial_invoice_retrieve
analytics_learners_retrieve
analytics_learners_list_retrieve
analytics_messages_retrieve
analytics_messages_details_retrieve
analytics_ratings_retrieve
analytics_sessions_retrieve
analytics_sessions_details_retrieve
analytics_time_retrieve
analytics_topics_retrieve
analytics_topics_details_retrieve
analytics_users_retrieve
analytics_users_details_r...
ibl-data-manager (4.84.1-ai-plus)
Request
User Analytics API - Comprehensive user activity metrics and trends.
Provides real-time and historical user analytics including:
- Currently active users (last hour)
- Active users over time periods (7d, 30d, 90d)
- Registered user counts and growth
- Time series charts with customizable granularity
Key Features:
- Real-time active user counting
- Percentage change calculations vs previous periods
- Flexible date filtering and granularity
- Platform and mentor-specific filtering
- Forward-filled time series data
Supported Metrics:
currently_active: Users active in last houractive_users: Unique users in specified periodregistered_users: Total and new user counts
Security
PlatformApiKeyAuthentication
Query
today- Today only7d- Last 7 days30d- Last 30 days90d- Last 90 daysall_time- All timecustom- Custom date range
Default "today"
Enum"today""7d""30d""90d""all_time""custom"
day- dayhour- hourweek- weekmonth- month
Default "hour"
Enum"day""hour""week""month"
currently_active- Users logged in right nowactive_users- Active users in a periodregistered_users- Registered usersactive_users_last_30d- Active users in the last 30 days
Enum"currently_active""active_users""registered_users""active_users_last_30d"
- Mock serverhttps://docs.ibl.ai/_mock/apis/ibl/api/analytics/users/
- https://base.manager.iblai.app/api/analytics/users/
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://docs.ibl.ai/_mock/apis/ibl/api/analytics/users/?date_filter=today&end_date=2019-08-24&granularity=day&mentor_unique_id=497f6eca-6276-4993-bfeb-53cbbbba6f08&metric=currently_active&platform_key=string&start_date=2019-08-24' \
-H 'Authorization: YOUR_API_KEY_HERE'Response
application/json
Users currently active in the last hour
{ "metric": "currently_active", "count": 45, "change": 12 }
Request
User Details API - Comprehensive user activity details with search and filtering.
Provides detailed user information including:
- User contact information (email, full name)
- Activity metrics (message count, last activity)
- Search functionality across multiple fields
- Flexible date range filtering
- CSV export capability
Key Features:
- Full-text search across email, name, and user ID
- Date range filtering for activity periods
- Platform and mentor-specific filtering
- Comprehensive pagination with metadata
- CSV export for data analysis
- User aggregation across platforms/mentors
Search Capabilities:
- Email address matching
- Full name search
- User ID lookup
- Partial string matching (case-insensitive)
Export Options:
- JSON response (default)
- CSV export (?export=csv)
- Includes all user fields in export
Security
PlatformApiKeyAuthentication
- Mock serverhttps://docs.ibl.ai/_mock/apis/ibl/api/analytics/users/details/
- https://base.manager.iblai.app/api/analytics/users/details/
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://docs.ibl.ai/_mock/apis/ibl/api/analytics/users/details/?date_filter=today&end_date=2019-08-24&limit=20&mentor_unique_id=497f6eca-6276-4993-bfeb-53cbbbba6f08&page=1&platform_key=string&search=string&start_date=2019-08-24' \
-H 'Authorization: YOUR_API_KEY_HERE'Response
application/json
Paginated list of users with activity details
{ "results": [ { … }, { … } ], "total": 1250, "pagination": { "page": 1, "limit": 50, "total_pages": 25, "has_next": true, "has_previous": false, "start_index": 1, "end_index": 50 } }