ibl-data-manager (3.59.0-ai-plus)
API for iblai
Request
List all learners on the platform with aggregated metrics.
This endpoint returns a paginated list of all learners with key metrics including:
- Enrollment counts
- Completion counts
- Time spent on platform
Query Parameters: page (int): Page number for pagination length (int): Number of items per page search (str): Filter learners by username, email, or name
Returns: A paginated list of learners with their associated metrics.
- Mock server
https://docs.ibl.ai/_mock/apis/ibl/api/audience/orgs/{org}/registered-users/
https://base.manager.iblai.app/api/audience/orgs/{org}/registered-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/audience/orgs/{org}/registered-users/?department_id=0&format=json&include_main_platform=true&length=0&page=0&search=string' \
-H 'Authorization: YOUR_API_KEY_HERE'{ "data": [ { … } ], "pagination": { "totalItems": 0, "currentPage": 0, "perPage": 0, "totalPages": 0 } }
Request
Get registered user counts over time.
This endpoint provides daily counts of new user registrations over a specified time period.
Query Parameters: start_date (str, optional): Start date for the time range (ISO format) end_date (str, optional): End date for the time range (ISO format)
Returns: Daily registration counts over the specified time period, with change metrics compared to previous periods.
Default time range is the last 7 days if no dates are specified.
- Mock server
https://docs.ibl.ai/_mock/apis/ibl/api/audience/orgs/{org}/registered-users/over-time
https://base.manager.iblai.app/api/audience/orgs/{org}/registered-users/over-time
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://docs.ibl.ai/_mock/apis/ibl/api/audience/orgs/{org}/registered-users/over-time?department_id=0&end_date=string&format=json&include_main_platform=true&start_date=string' \
-H 'Authorization: YOUR_API_KEY_HERE'{ "data": { "property1": null, "property2": null }, "total": 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 } }
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/audience/orgs/{org}/registered-users/per-course
https://base.manager.iblai.app/api/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/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 } }