Skip to content

/

/

ai_analytics_perlearner_orgs_users_overview_performance_index_retrieve

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

API for iblai

Download OpenAPI description

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_overview_grades_average_retrieve

Request

Get average grade value for platform, course, or user.

This endpoint returns the average grade at different levels:

Platform level: Average grade across all courses
Course level: Average grade for a specific course
Learner level: Average grade for a specific learner
Course-learner level: Grade for a specific learner in a specific course

Query Parameters: course_id (str, optional): Filter by course ID learner_id (str, optional): Filter by username or email

Returns: The average grade value based on the specified filters.

Access Control:

Platform admins can access any grade data
Learners can access their own grade 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

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}/overview/grades/average?department_id=0&format=json&include_main_platform=true' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json

dataobject(AverageData)required

data.averagenumber(double)required

Average

Response

application/json

{
  "data": {
    "average": 0.1
  }
}

ai_analytics_perlearner_orgs_users_overview_performance_index_retrieve

Request

Evaluates performance index for platform, per course, per user and per user-per course

Query Params course_id learner_id

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/ai-analytics/perlearner/orgs/{org}/users/{user_id}/overview/performance-index?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(ValueData)required

data.valuenumber(double)required

value

Response

application/json

{
  "data": {
    "value": 0.1
  }
}

ai_analytics_perlearner_orgs_users_overview_time_over_time_retrieve

Request

Time spent in secs on a per-day basis

Query Params

course_id e.g course-v1:Org+Course4+Run
user_id e.g developer@ibleducation.com or dev123 (username|email)
start_date e.g 2020-10-01
end_date e.g 2020-10-10

Default result when no query param is added is last_7_days (today inclusive)

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/ai-analytics/perlearner/orgs/{org}/users/{user_id}/overview/time/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-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

search

Operations

skills

Operations