ibl-data-manager (3.59.0-ai-plus)
API for iblai
Request
Get time spent statistics on a per-course basis.
This endpoint provides a paginated list of courses with the total time spent by users in each course.
Query Parameters: start_date (str, optional): Start date for filtering (ISO format) end_date (str, optional): End date for 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:
- Course identification (ID and name)
- Total time spent (in seconds)
- Formatted time spent (human-readable)
- Percentage of total platform time
- Mock server
https://docs.ibl.ai/_mock/apis/ibl/api/ai-analytics/engagement/orgs/{org}/time/per-course
https://base.manager.iblai.app/api/ai-analytics/engagement/orgs/{org}/time/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/engagement/orgs/{org}/time/per-course?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 } }
Request
Get video engagement metrics on a per-course basis.
This endpoint provides a paginated list of courses with video engagement metrics including view counts, completion rates, and time spent on videos.
Query Parameters: page (int, optional): Page number for pagination length (int, optional): Number of items per page
Returns: A paginated list of courses with their video engagement metrics.
- Mock server
https://docs.ibl.ai/_mock/apis/ibl/api/ai-analytics/engagement/orgs/{org}/videos/
https://base.manager.iblai.app/api/ai-analytics/engagement/orgs/{org}/videos/
- 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/engagement/orgs/{org}/videos/?department_id=0&format=json&include_main_platform=true&length=0&page=0' \
-H 'Authorization: YOUR_API_KEY_HERE'{ "data": [ { … } ], "pagination": { "totalItems": 0, "currentPage": 0, "perPage": 0, "totalPages": 0 } }
Request
Get video watch counts over time.
This endpoint provides daily counts of videos watched over a specified time period, with options to filter by course or user.
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) course_id (str, optional): Filter by course ID user_id (str, optional): Filter by username or email
Returns: Daily video watch counts over the specified time period.
Default time range is the last 7 days if no dates are specified.
Access Control:
- Platform admins can access any video watch data
- Learners can access their own video watch data
- Mock server
https://docs.ibl.ai/_mock/apis/ibl/api/ai-analytics/engagement/orgs/{org}/videos/over-time
https://base.manager.iblai.app/api/ai-analytics/engagement/orgs/{org}/videos/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/ai-analytics/engagement/orgs/{org}/videos/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 }