ibl-data-manager (3.59.0-ai-plus)
API for iblai
Request
Get a list of user groups with metrics and filtering options.
This endpoint provides a paginated list of user groups with aggregated metrics about learner performance, course completions, and skill acquisition.
This endpoint uses DM token authentication and respects department-based access controls.
Query Parameters: page (int, optional): Page number for pagination length (int, optional): Number of items per page program (str, optional): Filter by program pathway (str, optional): Filter by pathway groups (list, optional): Filter by group names location (str, optional): Filter by location is_enrolled (bool, optional): Filter for groups with enrolled users start_date (date, optional): Filter by learner join date (start range) end_date (date, optional): Filter by learner join date (end range)
Returns: A paginated list of user groups with comprehensive metrics.
Access Control:
- Platform admins can see all groups
- Department admins can only see groups in their departments
- Mock server
https://docs.ibl.ai/_mock/apis/ibl/api/ai-analytics/user-groups/orgs/{org}/
https://base.manager.iblai.app/api/ai-analytics/user-groups/orgs/{org}/
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://docs.ibl.ai/_mock/apis/ibl/api/ai-analytics/user-groups/orgs/{org}/?department_id=0&end_date=2019-08-24&format=json&groups=string&include_main_platform=true&is_enrolled=true&length=0&location=string&page=0&pathway=string&program=string&start_date=2019-08-24' \
-H 'Authorization: YOUR_API_KEY_HERE'{ "data": [ { … } ], "pagination": { "totalItems": 0, "currentPage": 0, "perPage": 0, "totalPages": 0 } }
Request
Update time spent tracking data from client-side events.
This endpoint receives time spent data collected on the client side and stores it in the analytics database. It requires a valid authentication token.
Methods: POST: Submit time spent tracking data
Returns: A response indicating success or failure: { "success": true|false, "message": "Error message if failed" (optional) }
Error Responses: 400 Bad Request: If the request data is invalid or the API is disabled
Notes: This API must be enabled via the ENABLE_TIME_SPENT_UPDATE_API setting.
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
- Mock server
https://docs.ibl.ai/_mock/apis/ibl/api/analytics/orgs/{org}/time/update/
https://base.manager.iblai.app/api/analytics/orgs/{org}/time/update/
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
'https://docs.ibl.ai/_mock/apis/ibl/api/analytics/orgs/{org}/time/update/' \
-H 'Authorization: YOUR_API_KEY_HERE' \
-H 'Content-Type: application/json' \
-d '{
"timestamp": "2019-08-24T14:15:22Z",
"course_id": "string",
"mentor_uuid": "string",
"block_id": "string",
"count": 0,
"url": "string",
"metadata": {},
"session_uuid": "string"
}'{ "success": true, "message": "Time spent updated successfully" }
- Mock server
https://docs.ibl.ai/_mock/apis/ibl/api/analytics/time-spent/user/
https://base.manager.iblai.app/api/analytics/time-spent/user/
- 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/time-spent/user/?course_id=string&end_date=2019-08-24&include_main_platform=true&learner_id=string&mentor_uuid=string&platform=string&session_uuid=string&start_date=2019-08-24&url=string'{ "total_seconds": 0 }