Skip to content
API Reference
/
ai-analytics
/
perlearner_orgs_users_videos_per_course_retrieve

ibl-data-manager (3.59.0-ai-plus)

API for iblai

Download OpenAPI description
ibl.json
ibl.yaml
Languages
Servers
Mock server

https://docs.ibl.ai/_mock/apis/ibl/

https://base.manager.iblai.app/

ai-account

Operations

ai-analytics

Operations

perlearner_orgs_users_videos_over_time_retrieve

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
Security
PlatformApiKeyAuthentication
Path
orgstringrequired
user_idstringrequired
Query
department_idinteger

When department_mode=1 is passed, it allows to filter data for only user content groups for the specified department

end_datestringnon-empty

end date. ISO 8601

formatstringnon-empty

Format

  • json - json
Default "json"
Value"json"
include_main_platformboolean

Include main platform data

Default true
start_datestringnon-empty

start date. ISO 8601

curl -i -X GET \
  'https://docs.ibl.ai/_mock/apis/ibl/api/perlearner/orgs/{org}/users/{user_id}/videos/over-time?department_id=0&end_date=string&format=json&include_main_platform=true&start_date=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json
dataobject

Dates are keys and values are the value for the date in the key. e,g {"2020-01-01": 30. ...}

totalinteger

Total

Response
application/json
{
  "data": {
    "property1": null,
    "property2": null
  },
  "total": 0
}

perlearner_orgs_users_videos_per_course_retrieve

Request

Summary Videos watched data for a learner per enrollment

Query Params

  1. user_id e.g developer@ibleducation.com or dev123 (username|email)
Security
PlatformApiKeyAuthentication
Path
orgstringrequired
user_idstringrequired
Query
department_idinteger

When department_mode=1 is passed, it allows to filter data for only user content groups for the specified department

end_datestringnon-empty

end date. ISO 8601

formatstringnon-empty

Format

  • json - json
Default "json"
Value"json"
include_main_platformboolean

Include main platform data

Default true
start_datestringnon-empty

start date. ISO 8601

curl -i -X GET \
  'https://docs.ibl.ai/_mock/apis/ibl/api/perlearner/orgs/{org}/users/{user_id}/videos/per-course?department_id=0&end_date=string&format=json&include_main_platform=true&start_date=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json
dataArray of objects(PerlearnerEngagementVideosData)required
data[].​course_idstringrequired

Edx Course ID

data[].​namestringrequired

Course Name

data[].​total_videosintegerrequired

Total course videos

data[].​watchedintegerrequired

Total videos watched by student

data[].​total_time_watchintegerrequired

Total time user watched video

data[].​average_class_watchnumber(double)required

Average videos watched by students in course

data[].​class_time_averagenumber(double)required

Average time spent by students on this course

Response
application/json
{
  "data": [
    { … }
  ]
}

platform_orgs_retrieve

Request

Get a list of registered users on the platform.

This endpoint provides a list of all registered users with basic profile information including username, name, email, and registration date.

Returns: A list of registered users with their profile information.

Security
PlatformApiKeyAuthentication
Path
orgstringrequired
curl -i -X GET \
  'https://docs.ibl.ai/_mock/apis/ibl/api/platform/orgs/{org}/' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

No response body

ai-bot

Operations

ai-finetuning

Operations

ai-index

Operations

ai-marketing

Operations

ai-media

Operations

ai-mentor

Operations

ai-prompt

Operations

career

Operations

catalog

Operations

core

Operations

credentials

Operations

features

Operations

media

Operations

notifications

Operations

scim

Operations

commerce

Operations

recommendations

Operations

reports

Operations

skills

Operations
Copyright © ibl.ai | support@iblai.zendesk.com