ibl-data-manager (3.59.0-ai-plus)
API for iblai
Request
List enrollment statistics on a per-course basis.
This endpoint provides enrollment counts for all courses, with options to filter for active or inactive enrollments and to include time-based data.
Query Parameters: active (bool): Filter for active enrollments when true, inactive when false start_date (str, optional): Start date for time-based filtering (ISO format) end_date (str, optional): End date for time-based filtering (ISO format) page (int, optional): Page number for pagination length (int, optional): Number of items per page
Returns: A paginated list of courses with their enrollment counts and percentages.
Any of y
, yes
, true
. set to false or no for unenrollments
y
- yyes
- yestrue
- trueTrue
- Truen
- nno
- nofalse
- falseFalse
- False
When department_mode=1
is passed, it allows to filter data for only user content groups for the specified department
- Mock server
https://docs.ibl.ai/_mock/apis/ibl/api/ai-analytics/audience/orgs/{org}/registered-users/per-course
https://base.manager.iblai.app/api/ai-analytics/audience/orgs/{org}/registered-users/per-course
- 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/audience/orgs/{org}/registered-users/per-course?active=y&department_id=0&end_date=string&format=json&include_main_platform=true&length=0&page=0&start_date=string' \
-H 'Authorization: YOUR_API_KEY_HERE'
{ "data": [ { … } ], "pagination": { "totalItems": 0, "currentPage": 0, "perPage": 0, "totalPages": 0 }, "meta": { "total": 0, "change_range": 0, "change_last_seven_days": 0, "change_last_thirty_days": 0, "change_last_seven_days_percent": 0, "change_last_thirty_days_percent": 0, "change_range_percent": 0.1 } }
- Mock server
https://docs.ibl.ai/_mock/apis/ibl/api/ai-analytics/costs/pertenant/
https://base.manager.iblai.app/api/ai-analytics/costs/pertenant/
- 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/costs/pertenant/?end_date=2019-08-24T14%3A15%3A22Z&start_date=2019-08-24T14%3A15%3A22Z' \
-H 'Authorization: YOUR_API_KEY_HERE'
[ [ { … } ] ]
Request
Get a list of departments with metrics and filtering options.
This endpoint provides a paginated list of departments with aggregated metrics about learner performance, course completions, and skill acquisition.
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 departments (list, optional): Filter by department ids department_id (str, optional): Filter by department id location (str, optional): Filter by location is_enrolled (bool, optional): Filter for departments 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 departments with comprehensive metrics.
- Mock server
https://docs.ibl.ai/_mock/apis/ibl/api/ai-analytics/departments/orgs/{org}/
https://base.manager.iblai.app/api/ai-analytics/departments/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/departments/orgs/{org}/?department_id=0&departments=string&end_date=2019-08-24&format=json&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 } }