Skip to content
API Reference
/
ai-analytics
/
ai_analytics_perlearner_orgs_users_grades_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

ai_analytics_perlearner_orgs_users_courses_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
course_idstring^((\w*)-(\w*):[^+]+(|\+)[^+]+(|\+)\+\w+)$required
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/ai-analytics/perlearner/orgs/{org}/users/{user_id}/courses/{course_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
}

ai_analytics_perlearner_orgs_users_grades_per_course_retrieve

Request

Summary Grading Information for a learner on a per-enrollment basis

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

formatstringnon-empty

Format

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

Include main platform data

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

Responses

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

Edx Course ID

data[].​namestringrequired

Course Name

data[].​graded_activitiesstringrequired

Total problems in course

data[].​submissionsintegerrequired

Cumulative problem submissions

data[].​problems_attemptedintegerrequired

Number of problems from total problems attempted

data[].​assignments_correctintegerrequired

Number of problems answered correctly

data[].​class_averagenumber(double)required

Average grade obtained by all learner in the course

data[].​gradenumber(double)required

Learner course grade

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

ai_analytics_perlearner_orgs_users_info_retrieve

Request

Retrieve detailed information about a specific learner.

This endpoint returns personal and activity information about a learner, including profile data, activity metrics, and location information.

Path Parameters: user_id (str): The username or email of the learner

Query Parameters: meta (bool): Include additional analytics information when true

Returns: Detailed learner information including:

  • Profile data (username, name, email)
  • Registration and activity dates
  • Activity metrics (assessments, time spent, videos watched)
  • Location and browser information (when available)

Access Control:

  • Platform admins can access any learner
  • Learners can access their own information
  • Department admins can access learners in their departments
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

formatstringnon-empty

Format

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

Include main platform data

Default true
metastringnon-empty

Include extra analytics information?

  • y - y
  • yes - yes
  • true - true
  • True - True
  • n - n
  • no - no
  • false - false
  • False - False
Default "n"
Enum"y""yes""true""True""n""no""false""False"
searchstringnon-empty
curl -i -X GET \
  'https://docs.ibl.ai/_mock/apis/ibl/api/ai-analytics/perlearner/orgs/{org}/users/{user_id}/info?department_id=0&format=json&include_main_platform=true&meta=y&search=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json
dataobject(LearnerInformationAPIData)required
data.​usernamestringrequired

learner username

data.​namestringrequired

learner Name

data.​emailstringrequired

learner email

data.​date_joinedstringrequired

Registration Timestamp e.g 2022-05-05T00:00:00+00:00

data.​last_activitystringrequired

Last Activity Timestamp e.g 2022-05-05T00:00:00+00:00

data.​total_assessmentsinteger

Total assessments attempted

data.​total_time_spentinteger

Total time spent in seconds

data.​total_videosinteger

Total videos watched

data.​course_completionsinteger

Total courses completed

data.​time_spent_overtimeobject
data.​continentstring

last location - continent

data.​continent_codestring

last location - continent code

data.​countrystring

last location - country

data.​country_codestring

last location - country code

data.​regionstring

last location - region

data.​region_codestring

last location - region code

data.​locationstring

last location

data.​citystring

last location - city

data.​browserstring

last known browser

data.​operating_systemstring

last known operating system

data.​resolutionstring

last known browser resolution

Response
application/json
{
  "data": {
    "username": "string",
    "name": "string",
    "email": "string",
    "date_joined": "string",
    "last_activity": "string",
    "total_assessments": 0,
    "total_time_spent": 0,
    "total_videos": 0,
    "course_completions": 0,
    "time_spent_overtime": { … },
    "continent": "string",
    "continent_code": "string",
    "country": "string",
    "country_code": "string",
    "region": "string",
    "region_code": "string",
    "location": "string",
    "city": "string",
    "browser": "string",
    "operating_system": "string",
    "resolution": "string"
  }
}

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