All URIs are relative to https://base.manager.iblai.app
| Method | HTTP request | Description |
|---|---|---|
| perlearner_orgs_users_activity_retrieve | GET /api/perlearner/orgs/{org}/users/{user_id}/activity/ | |
| perlearner_orgs_users_courses_grading_cutoffs_retrieve | GET /api/perlearner/orgs/{org}/users/{user_id}/courses/{course_id}/grading/cutoffs | |
| perlearner_orgs_users_courses_grading_detail_retrieve | GET /api/perlearner/orgs/{org}/users/{user_id}/courses/{course_id}/grading/detail | |
| perlearner_orgs_users_courses_grading_summary_retrieve | GET /api/perlearner/orgs/{org}/users/{user_id}/courses/{course_id}/grading/summary | |
| perlearner_orgs_users_courses_overview_engagement_index_retrieve | GET /api/perlearner/orgs/{org}/users/{user_id}/courses/{course_id}/overview/engagement-index | |
| perlearner_orgs_users_courses_overview_grade_retrieve | GET /api/perlearner/orgs/{org}/users/{user_id}/courses/{course_id}/overview/grade | |
| perlearner_orgs_users_courses_overview_performance_index_retrieve | GET /api/perlearner/orgs/{org}/users/{user_id}/courses/{course_id}/overview/performance-index | |
| perlearner_orgs_users_courses_overview_time_over_time_retrieve | GET /api/perlearner/orgs/{org}/users/{user_id}/courses/{course_id}/overview/time/over-time | |
| perlearner_orgs_users_courses_videos_over_time_retrieve | GET /api/perlearner/orgs/{org}/users/{user_id}/courses/{course_id}/videos/over-time | |
| perlearner_orgs_users_courses_videos_retrieve | GET /api/perlearner/orgs/{org}/users/{user_id}/courses/{course_id}/videos | |
| perlearner_orgs_users_grades_per_course_retrieve | GET /api/perlearner/orgs/{org}/users/{user_id}/grades/per-course | |
| perlearner_orgs_users_info_retrieve | GET /api/perlearner/orgs/{org}/users/{user_id}/info | |
| perlearner_orgs_users_last_access_retrieve | GET /api/perlearner/orgs/{org}/users/{user_id}/last-access | |
| perlearner_orgs_users_overview_engagement_index_retrieve | GET /api/perlearner/orgs/{org}/users/{user_id}/overview/engagement-index | |
| perlearner_orgs_users_overview_grades_average_retrieve | GET /api/perlearner/orgs/{org}/users/{user_id}/overview/grades/average | |
| perlearner_orgs_users_overview_performance_index_retrieve | GET /api/perlearner/orgs/{org}/users/{user_id}/overview/performance-index | |
| perlearner_orgs_users_overview_time_over_time_retrieve | GET /api/perlearner/orgs/{org}/users/{user_id}/overview/time/over-time | |
| perlearner_orgs_users_retrieve | GET /api/perlearner/orgs/{org}/users | |
| perlearner_orgs_users_videos_over_time_retrieve | GET /api/perlearner/orgs/{org}/users/{user_id}/videos/over-time | |
| perlearner_orgs_users_videos_per_course_retrieve | GET /api/perlearner/orgs/{org}/users/{user_id}/videos/per-course |
ActivityAPI perlearner_orgs_users_activity_retrieve(org, user_id, format=format, include_main_platform=include_main_platform)
Provides information on user enrollments Params user_id e.g [email protected]| developer
- Api Key Authentication (PlatformApiKeyAuthentication):
import iblai
from iblai.models.activity_api import ActivityAPI
from iblai.rest import ApiException
from pprint import pprint
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# The APIs use bearer tokens for authentication with a prefix of: `Api-Key`
# You can generate an authenticated client using the following helper method
client = get_platform_api_client(
host="https://base.manager.iblai.app",
key=os.environ["API_KEY"]
)
# Create an instance of the API class
api_instance = iblai.PerlearnerApi(api_client)
org = 'org_example' # str |
user_id = 'user_id_example' # str |
format = json # str | Format * `json` - json (optional) (default to json)
include_main_platform = True # bool | Include main platform data (optional) (default to True)
try:
api_response = api_instance.perlearner_orgs_users_activity_retrieve(org, user_id, format=format, include_main_platform=include_main_platform)
print("The response of PerlearnerApi->perlearner_orgs_users_activity_retrieve:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling PerlearnerApi->perlearner_orgs_users_activity_retrieve: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| org | str | ||
| user_id | str | ||
| format | str | Format * `json` - json | [optional] [default to json] |
| include_main_platform | bool | Include main platform data | [optional] [default to True] |
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
PerlearnerGradeWithCutOff perlearner_orgs_users_courses_grading_cutoffs_retrieve(course_id, org, user_id, end_date=end_date, format=format, include_main_platform=include_main_platform, start_date=start_date)
Provides about a learner current grade in a course with the course cut Kwargs 1. course_id e.g course-v1:Org+Course4+Run 2. user_id e.g [email protected] or dev123 (username|email)
- Api Key Authentication (PlatformApiKeyAuthentication):
import iblai
from iblai.models.perlearner_grade_with_cut_off import PerlearnerGradeWithCutOff
from iblai.rest import ApiException
from pprint import pprint
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# The APIs use bearer tokens for authentication with a prefix of: `Api-Key`
# You can generate an authenticated client using the following helper method
client = get_platform_api_client(
host="https://base.manager.iblai.app",
key=os.environ["API_KEY"]
)
# Create an instance of the API class
api_instance = iblai.PerlearnerApi(api_client)
course_id = 'course_id_example' # str |
org = 'org_example' # str |
user_id = 'user_id_example' # str |
end_date = 'end_date_example' # str | end date. ISO 8601 (optional)
format = json # str | Format * `json` - json (optional) (default to json)
include_main_platform = True # bool | Include main platform data (optional) (default to True)
start_date = 'start_date_example' # str | start date. ISO 8601 (optional)
try:
api_response = api_instance.perlearner_orgs_users_courses_grading_cutoffs_retrieve(course_id, org, user_id, end_date=end_date, format=format, include_main_platform=include_main_platform, start_date=start_date)
print("The response of PerlearnerApi->perlearner_orgs_users_courses_grading_cutoffs_retrieve:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling PerlearnerApi->perlearner_orgs_users_courses_grading_cutoffs_retrieve: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| course_id | str | ||
| org | str | ||
| user_id | str | ||
| end_date | str | end date. ISO 8601 | [optional] |
| format | str | Format * `json` - json | [optional] [default to json] |
| include_main_platform | bool | Include main platform data | [optional] [default to True] |
| start_date | str | start date. ISO 8601 | [optional] |
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
DetailedGradeView perlearner_orgs_users_courses_grading_detail_retrieve(course_id, org, user_id, end_date=end_date, format=format, include_main_platform=include_main_platform, start_date=start_date)
Mixin that includes the StudentTokenAuthentication and IsAdminUserOrStudent
- Api Key Authentication (PlatformApiKeyAuthentication):
import iblai
from iblai.models.detailed_grade_view import DetailedGradeView
from iblai.rest import ApiException
from pprint import pprint
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# The APIs use bearer tokens for authentication with a prefix of: `Api-Key`
# You can generate an authenticated client using the following helper method
client = get_platform_api_client(
host="https://base.manager.iblai.app",
key=os.environ["API_KEY"]
)
# Create an instance of the API class
api_instance = iblai.PerlearnerApi(api_client)
course_id = 'course_id_example' # str |
org = 'org_example' # str |
user_id = 'user_id_example' # str |
end_date = 'end_date_example' # str | end date. ISO 8601 (optional)
format = json # str | Format * `json` - json (optional) (default to json)
include_main_platform = True # bool | Include main platform data (optional) (default to True)
start_date = 'start_date_example' # str | start date. ISO 8601 (optional)
try:
api_response = api_instance.perlearner_orgs_users_courses_grading_detail_retrieve(course_id, org, user_id, end_date=end_date, format=format, include_main_platform=include_main_platform, start_date=start_date)
print("The response of PerlearnerApi->perlearner_orgs_users_courses_grading_detail_retrieve:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling PerlearnerApi->perlearner_orgs_users_courses_grading_detail_retrieve: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| course_id | str | ||
| org | str | ||
| user_id | str | ||
| end_date | str | end date. ISO 8601 | [optional] |
| format | str | Format * `json` - json | [optional] [default to json] |
| include_main_platform | bool | Include main platform data | [optional] [default to True] |
| start_date | str | start date. ISO 8601 | [optional] |
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
PerlearnerGradeSummary perlearner_orgs_users_courses_grading_summary_retrieve(course_id, org, user_id, end_date=end_date, format=format, include_main_platform=include_main_platform, start_date=start_date)
Query Params 1. course_id e.g course-v1:Org+Course4+Run 2. user_id e.g [email protected] or dev123 (username|email)
- Api Key Authentication (PlatformApiKeyAuthentication):
import iblai
from iblai.models.perlearner_grade_summary import PerlearnerGradeSummary
from iblai.rest import ApiException
from pprint import pprint
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# The APIs use bearer tokens for authentication with a prefix of: `Api-Key`
# You can generate an authenticated client using the following helper method
client = get_platform_api_client(
host="https://base.manager.iblai.app",
key=os.environ["API_KEY"]
)
# Create an instance of the API class
api_instance = iblai.PerlearnerApi(api_client)
course_id = 'course_id_example' # str |
org = 'org_example' # str |
user_id = 'user_id_example' # str |
end_date = 'end_date_example' # str | end date. ISO 8601 (optional)
format = json # str | Format * `json` - json (optional) (default to json)
include_main_platform = True # bool | Include main platform data (optional) (default to True)
start_date = 'start_date_example' # str | start date. ISO 8601 (optional)
try:
api_response = api_instance.perlearner_orgs_users_courses_grading_summary_retrieve(course_id, org, user_id, end_date=end_date, format=format, include_main_platform=include_main_platform, start_date=start_date)
print("The response of PerlearnerApi->perlearner_orgs_users_courses_grading_summary_retrieve:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling PerlearnerApi->perlearner_orgs_users_courses_grading_summary_retrieve: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| course_id | str | ||
| org | str | ||
| user_id | str | ||
| end_date | str | end date. ISO 8601 | [optional] |
| format | str | Format * `json` - json | [optional] [default to json] |
| include_main_platform | bool | Include main platform data | [optional] [default to True] |
| start_date | str | start date. ISO 8601 | [optional] |
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
Value perlearner_orgs_users_courses_overview_engagement_index_retrieve(course_id, org, user_id)
Average of days with atleast an activity within ENGAGEMENT_INDEX_PERIOD consecutive days for a learner in a course
- Api Key Authentication (PlatformApiKeyAuthentication):
import iblai
from iblai.models.value import Value
from iblai.rest import ApiException
from pprint import pprint
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# The APIs use bearer tokens for authentication with a prefix of: `Api-Key`
# You can generate an authenticated client using the following helper method
client = get_platform_api_client(
host="https://base.manager.iblai.app",
key=os.environ["API_KEY"]
)
# Create an instance of the API class
api_instance = iblai.PerlearnerApi(api_client)
course_id = 'course_id_example' # str |
org = 'org_example' # str |
user_id = 'user_id_example' # str |
try:
api_response = api_instance.perlearner_orgs_users_courses_overview_engagement_index_retrieve(course_id, org, user_id)
print("The response of PerlearnerApi->perlearner_orgs_users_courses_overview_engagement_index_retrieve:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling PerlearnerApi->perlearner_orgs_users_courses_overview_engagement_index_retrieve: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| course_id | str | ||
| org | str | ||
| user_id | str |
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
PerlearnerGradeWithCutOff perlearner_orgs_users_courses_overview_grade_retrieve(course_id, org, user_id, end_date=end_date, format=format, include_main_platform=include_main_platform, start_date=start_date)
Provides about a learner current grade in a course with the course cut Kwargs 1. course_id e.g course-v1:Org+Course4+Run 2. user_id e.g [email protected] or dev123 (username|email)
- Api Key Authentication (PlatformApiKeyAuthentication):
import iblai
from iblai.models.perlearner_grade_with_cut_off import PerlearnerGradeWithCutOff
from iblai.rest import ApiException
from pprint import pprint
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# The APIs use bearer tokens for authentication with a prefix of: `Api-Key`
# You can generate an authenticated client using the following helper method
client = get_platform_api_client(
host="https://base.manager.iblai.app",
key=os.environ["API_KEY"]
)
# Create an instance of the API class
api_instance = iblai.PerlearnerApi(api_client)
course_id = 'course_id_example' # str |
org = 'org_example' # str |
user_id = 'user_id_example' # str |
end_date = 'end_date_example' # str | end date. ISO 8601 (optional)
format = json # str | Format * `json` - json (optional) (default to json)
include_main_platform = True # bool | Include main platform data (optional) (default to True)
start_date = 'start_date_example' # str | start date. ISO 8601 (optional)
try:
api_response = api_instance.perlearner_orgs_users_courses_overview_grade_retrieve(course_id, org, user_id, end_date=end_date, format=format, include_main_platform=include_main_platform, start_date=start_date)
print("The response of PerlearnerApi->perlearner_orgs_users_courses_overview_grade_retrieve:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling PerlearnerApi->perlearner_orgs_users_courses_overview_grade_retrieve: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| course_id | str | ||
| org | str | ||
| user_id | str | ||
| end_date | str | end date. ISO 8601 | [optional] |
| format | str | Format * `json` - json | [optional] [default to json] |
| include_main_platform | bool | Include main platform data | [optional] [default to True] |
| start_date | str | start date. ISO 8601 | [optional] |
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
Value perlearner_orgs_users_courses_overview_performance_index_retrieve(course_id, org, user_id, end_date=end_date, format=format, include_main_platform=include_main_platform, start_date=start_date)
Evaluates performance index for platform, per course, per user and per user-per course Query Params course_id learner_id
- Api Key Authentication (PlatformApiKeyAuthentication):
import iblai
from iblai.models.value import Value
from iblai.rest import ApiException
from pprint import pprint
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# The APIs use bearer tokens for authentication with a prefix of: `Api-Key`
# You can generate an authenticated client using the following helper method
client = get_platform_api_client(
host="https://base.manager.iblai.app",
key=os.environ["API_KEY"]
)
# Create an instance of the API class
api_instance = iblai.PerlearnerApi(api_client)
course_id = 'course_id_example' # str |
org = 'org_example' # str |
user_id = 'user_id_example' # str |
end_date = 'end_date_example' # str | end date. ISO 8601 (optional)
format = json # str | Format * `json` - json (optional) (default to json)
include_main_platform = True # bool | Include main platform data (optional) (default to True)
start_date = 'start_date_example' # str | start date. ISO 8601 (optional)
try:
api_response = api_instance.perlearner_orgs_users_courses_overview_performance_index_retrieve(course_id, org, user_id, end_date=end_date, format=format, include_main_platform=include_main_platform, start_date=start_date)
print("The response of PerlearnerApi->perlearner_orgs_users_courses_overview_performance_index_retrieve:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling PerlearnerApi->perlearner_orgs_users_courses_overview_performance_index_retrieve: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| course_id | str | ||
| org | str | ||
| user_id | str | ||
| end_date | str | end date. ISO 8601 | [optional] |
| format | str | Format * `json` - json | [optional] [default to json] |
| include_main_platform | bool | Include main platform data | [optional] [default to True] |
| start_date | str | start date. ISO 8601 | [optional] |
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
OverTimeWithTotal perlearner_orgs_users_courses_overview_time_over_time_retrieve(course_id, org, user_id, end_date=end_date, format=format, include_main_platform=include_main_platform, start_date=start_date)
Time spent within a course in secs on a per-day basis Kwargs 1. course_id e.g course-v1:Org+Course4+Run 2. user_id e.g [email protected] or dev123 (username|email) Query Params 3. start_date e.g 2020-10-01 4. end_date e.g 2020-10-10 Default result when no query param is added is last_7_days (today inclusive)
- Api Key Authentication (PlatformApiKeyAuthentication):
import iblai
from iblai.models.over_time_with_total import OverTimeWithTotal
from iblai.rest import ApiException
from pprint import pprint
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# The APIs use bearer tokens for authentication with a prefix of: `Api-Key`
# You can generate an authenticated client using the following helper method
client = get_platform_api_client(
host="https://base.manager.iblai.app",
key=os.environ["API_KEY"]
)
# Create an instance of the API class
api_instance = iblai.PerlearnerApi(api_client)
course_id = 'course_id_example' # str |
org = 'org_example' # str |
user_id = 'user_id_example' # str |
end_date = 'end_date_example' # str | end date. ISO 8601 (optional)
format = json # str | Format * `json` - json (optional) (default to json)
include_main_platform = True # bool | Include main platform data (optional) (default to True)
start_date = 'start_date_example' # str | start date. ISO 8601 (optional)
try:
api_response = api_instance.perlearner_orgs_users_courses_overview_time_over_time_retrieve(course_id, org, user_id, end_date=end_date, format=format, include_main_platform=include_main_platform, start_date=start_date)
print("The response of PerlearnerApi->perlearner_orgs_users_courses_overview_time_over_time_retrieve:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling PerlearnerApi->perlearner_orgs_users_courses_overview_time_over_time_retrieve: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| course_id | str | ||
| org | str | ||
| user_id | str | ||
| end_date | str | end date. ISO 8601 | [optional] |
| format | str | Format * `json` - json | [optional] [default to json] |
| include_main_platform | bool | Include main platform data | [optional] [default to True] |
| start_date | str | start date. ISO 8601 | [optional] |
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
OverTimeWithTotal perlearner_orgs_users_courses_videos_over_time_retrieve(course_id, org, user_id, end_date=end_date, format=format, include_main_platform=include_main_platform, start_date=start_date)
Watched Videos count on a per-day basis Kwargs 1. course_id e.g course-v1:Org+Course4+Run 2. user_id e.g [email protected] or dev123 (username|email) Query Params 3. start_date e.g 2020-10-01 4. end_date e.g 2020-10-10 Default result when no query param is added is last_7_days (today inclusive)
- Api Key Authentication (PlatformApiKeyAuthentication):
import iblai
from iblai.models.over_time_with_total import OverTimeWithTotal
from iblai.rest import ApiException
from pprint import pprint
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# The APIs use bearer tokens for authentication with a prefix of: `Api-Key`
# You can generate an authenticated client using the following helper method
client = get_platform_api_client(
host="https://base.manager.iblai.app",
key=os.environ["API_KEY"]
)
# Create an instance of the API class
api_instance = iblai.PerlearnerApi(api_client)
course_id = 'course_id_example' # str |
org = 'org_example' # str |
user_id = 'user_id_example' # str |
end_date = 'end_date_example' # str | end date. ISO 8601 (optional)
format = json # str | Format * `json` - json (optional) (default to json)
include_main_platform = True # bool | Include main platform data (optional) (default to True)
start_date = 'start_date_example' # str | start date. ISO 8601 (optional)
try:
api_response = api_instance.perlearner_orgs_users_courses_videos_over_time_retrieve(course_id, org, user_id, end_date=end_date, format=format, include_main_platform=include_main_platform, start_date=start_date)
print("The response of PerlearnerApi->perlearner_orgs_users_courses_videos_over_time_retrieve:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling PerlearnerApi->perlearner_orgs_users_courses_videos_over_time_retrieve: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| course_id | str | ||
| org | str | ||
| user_id | str | ||
| end_date | str | end date. ISO 8601 | [optional] |
| format | str | Format * `json` - json | [optional] [default to json] |
| include_main_platform | bool | Include main platform data | [optional] [default to True] |
| start_date | str | start date. ISO 8601 | [optional] |
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
PerLearnerCourseVideosWatched perlearner_orgs_users_courses_videos_retrieve(course_id, org, user_id, format=format, include_main_platform=include_main_platform)
List of videos within a course a learner has watched Kwargs 1. course_id e.g course-v1:Org+Course4+Run 2. user_id e.g [email protected] or dev123 (username|email) Default result when no query param is added is [], 0
- Api Key Authentication (PlatformApiKeyAuthentication):
import iblai
from iblai.models.per_learner_course_videos_watched import PerLearnerCourseVideosWatched
from iblai.rest import ApiException
from pprint import pprint
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# The APIs use bearer tokens for authentication with a prefix of: `Api-Key`
# You can generate an authenticated client using the following helper method
client = get_platform_api_client(
host="https://base.manager.iblai.app",
key=os.environ["API_KEY"]
)
# Create an instance of the API class
api_instance = iblai.PerlearnerApi(api_client)
course_id = 'course_id_example' # str |
org = 'org_example' # str |
user_id = 'user_id_example' # str |
format = json # str | Format * `json` - json (optional) (default to json)
include_main_platform = True # bool | Include main platform data (optional) (default to True)
try:
api_response = api_instance.perlearner_orgs_users_courses_videos_retrieve(course_id, org, user_id, format=format, include_main_platform=include_main_platform)
print("The response of PerlearnerApi->perlearner_orgs_users_courses_videos_retrieve:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling PerlearnerApi->perlearner_orgs_users_courses_videos_retrieve: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| course_id | str | ||
| org | str | ||
| user_id | str | ||
| format | str | Format * `json` - json | [optional] [default to json] |
| include_main_platform | bool | Include main platform data | [optional] [default to True] |
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
PerlearnerGradingPerCourseAPI perlearner_orgs_users_grades_per_course_retrieve(org, user_id, format=format, include_main_platform=include_main_platform)
Summary Grading Information for a learner on a per-enrollment basis Query Params 1. user_id e.g [email protected] or dev123 (username|email)
- Api Key Authentication (PlatformApiKeyAuthentication):
import iblai
from iblai.models.perlearner_grading_per_course_api import PerlearnerGradingPerCourseAPI
from iblai.rest import ApiException
from pprint import pprint
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# The APIs use bearer tokens for authentication with a prefix of: `Api-Key`
# You can generate an authenticated client using the following helper method
client = get_platform_api_client(
host="https://base.manager.iblai.app",
key=os.environ["API_KEY"]
)
# Create an instance of the API class
api_instance = iblai.PerlearnerApi(api_client)
org = 'org_example' # str |
user_id = 'user_id_example' # str |
format = json # str | Format * `json` - json (optional) (default to json)
include_main_platform = True # bool | Include main platform data (optional) (default to True)
try:
api_response = api_instance.perlearner_orgs_users_grades_per_course_retrieve(org, user_id, format=format, include_main_platform=include_main_platform)
print("The response of PerlearnerApi->perlearner_orgs_users_grades_per_course_retrieve:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling PerlearnerApi->perlearner_orgs_users_grades_per_course_retrieve: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| org | str | ||
| user_id | str | ||
| format | str | Format * `json` - json | [optional] [default to json] |
| include_main_platform | bool | Include main platform data | [optional] [default to True] |
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
LearnerInformationAPI perlearner_orgs_users_info_retrieve(org, user_id, format=format, include_main_platform=include_main_platform, meta=meta, search=search)
Returns dictionary of user PII
- Api Key Authentication (PlatformApiKeyAuthentication):
import iblai
from iblai.models.learner_information_api import LearnerInformationAPI
from iblai.rest import ApiException
from pprint import pprint
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# The APIs use bearer tokens for authentication with a prefix of: `Api-Key`
# You can generate an authenticated client using the following helper method
client = get_platform_api_client(
host="https://base.manager.iblai.app",
key=os.environ["API_KEY"]
)
# Create an instance of the API class
api_instance = iblai.PerlearnerApi(api_client)
org = 'org_example' # str |
user_id = 'user_id_example' # str |
format = json # str | Format * `json` - json (optional) (default to json)
include_main_platform = True # bool | Include main platform data (optional) (default to True)
meta = n # str | Include extra analytics information? * `y` - y * `yes` - yes * `true` - true * `True` - True * `n` - n * `no` - no * `false` - false * `False` - False (optional) (default to n)
search = 'search_example' # str | (optional)
try:
api_response = api_instance.perlearner_orgs_users_info_retrieve(org, user_id, format=format, include_main_platform=include_main_platform, meta=meta, search=search)
print("The response of PerlearnerApi->perlearner_orgs_users_info_retrieve:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling PerlearnerApi->perlearner_orgs_users_info_retrieve: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| org | str | ||
| user_id | str | ||
| format | str | Format * `json` - json | [optional] [default to json] |
| include_main_platform | bool | Include main platform data | [optional] [default to True] |
| meta | str | Include extra analytics information? * `y` - y * `yes` - yes * `true` - true * `True` - True * `n` - n * `no` - no * `false` - false * `False` - False | [optional] [default to n] |
| search | str | [optional] |
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
PerLearnerLastAccess perlearner_orgs_users_last_access_retrieve(org, user_id, format=format, include_main_platform=include_main_platform)
Last course accessed by a learner, includes upto unit information as well
- Api Key Authentication (PlatformApiKeyAuthentication):
import iblai
from iblai.models.per_learner_last_access import PerLearnerLastAccess
from iblai.rest import ApiException
from pprint import pprint
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# The APIs use bearer tokens for authentication with a prefix of: `Api-Key`
# You can generate an authenticated client using the following helper method
client = get_platform_api_client(
host="https://base.manager.iblai.app",
key=os.environ["API_KEY"]
)
# Create an instance of the API class
api_instance = iblai.PerlearnerApi(api_client)
org = 'org_example' # str |
user_id = 'user_id_example' # str |
format = json # str | Format * `json` - json (optional) (default to json)
include_main_platform = True # bool | Include main platform data (optional) (default to True)
try:
api_response = api_instance.perlearner_orgs_users_last_access_retrieve(org, user_id, format=format, include_main_platform=include_main_platform)
print("The response of PerlearnerApi->perlearner_orgs_users_last_access_retrieve:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling PerlearnerApi->perlearner_orgs_users_last_access_retrieve: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| org | str | ||
| user_id | str | ||
| format | str | Format * `json` - json | [optional] [default to json] |
| include_main_platform | bool | Include main platform data | [optional] [default to True] |
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
Value perlearner_orgs_users_overview_engagement_index_retrieve(org, user_id, end_date=end_date, format=format, include_main_platform=include_main_platform, start_date=start_date)
Average of days with atleast an activity within ENGAGEMENT_INDEX_PERIOD consecutive days
- Api Key Authentication (PlatformApiKeyAuthentication):
import iblai
from iblai.models.value import Value
from iblai.rest import ApiException
from pprint import pprint
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# The APIs use bearer tokens for authentication with a prefix of: `Api-Key`
# You can generate an authenticated client using the following helper method
client = get_platform_api_client(
host="https://base.manager.iblai.app",
key=os.environ["API_KEY"]
)
# Create an instance of the API class
api_instance = iblai.PerlearnerApi(api_client)
org = 'org_example' # str |
user_id = 'user_id_example' # str |
end_date = 'end_date_example' # str | end date. ISO 8601 (optional)
format = json # str | Format * `json` - json (optional) (default to json)
include_main_platform = True # bool | Include main platform data (optional) (default to True)
start_date = 'start_date_example' # str | start date. ISO 8601 (optional)
try:
api_response = api_instance.perlearner_orgs_users_overview_engagement_index_retrieve(org, user_id, end_date=end_date, format=format, include_main_platform=include_main_platform, start_date=start_date)
print("The response of PerlearnerApi->perlearner_orgs_users_overview_engagement_index_retrieve:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling PerlearnerApi->perlearner_orgs_users_overview_engagement_index_retrieve: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| org | str | ||
| user_id | str | ||
| end_date | str | end date. ISO 8601 | [optional] |
| format | str | Format * `json` - json | [optional] [default to json] |
| include_main_platform | bool | Include main platform data | [optional] [default to True] |
| start_date | str | start date. ISO 8601 | [optional] |
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
Average perlearner_orgs_users_overview_grades_average_retrieve(org, user_id, format=format, include_main_platform=include_main_platform)
Average grade value for platform, course, or user. Query Params course_id e.g course-v1:Org+Course4+Run learner_id e.g std123 , [email protected]
- Api Key Authentication (PlatformApiKeyAuthentication):
import iblai
from iblai.models.average import Average
from iblai.rest import ApiException
from pprint import pprint
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# The APIs use bearer tokens for authentication with a prefix of: `Api-Key`
# You can generate an authenticated client using the following helper method
client = get_platform_api_client(
host="https://base.manager.iblai.app",
key=os.environ["API_KEY"]
)
# Create an instance of the API class
api_instance = iblai.PerlearnerApi(api_client)
org = 'org_example' # str |
user_id = 'user_id_example' # str |
format = json # str | Format * `json` - json (optional) (default to json)
include_main_platform = True # bool | Include main platform data (optional) (default to True)
try:
api_response = api_instance.perlearner_orgs_users_overview_grades_average_retrieve(org, user_id, format=format, include_main_platform=include_main_platform)
print("The response of PerlearnerApi->perlearner_orgs_users_overview_grades_average_retrieve:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling PerlearnerApi->perlearner_orgs_users_overview_grades_average_retrieve: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| org | str | ||
| user_id | str | ||
| format | str | Format * `json` - json | [optional] [default to json] |
| include_main_platform | bool | Include main platform data | [optional] [default to True] |
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
Value perlearner_orgs_users_overview_performance_index_retrieve(org, user_id, end_date=end_date, format=format, include_main_platform=include_main_platform, start_date=start_date)
Evaluates performance index for platform, per course, per user and per user-per course Query Params course_id learner_id
- Api Key Authentication (PlatformApiKeyAuthentication):
import iblai
from iblai.models.value import Value
from iblai.rest import ApiException
from pprint import pprint
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# The APIs use bearer tokens for authentication with a prefix of: `Api-Key`
# You can generate an authenticated client using the following helper method
client = get_platform_api_client(
host="https://base.manager.iblai.app",
key=os.environ["API_KEY"]
)
# Create an instance of the API class
api_instance = iblai.PerlearnerApi(api_client)
org = 'org_example' # str |
user_id = 'user_id_example' # str |
end_date = 'end_date_example' # str | end date. ISO 8601 (optional)
format = json # str | Format * `json` - json (optional) (default to json)
include_main_platform = True # bool | Include main platform data (optional) (default to True)
start_date = 'start_date_example' # str | start date. ISO 8601 (optional)
try:
api_response = api_instance.perlearner_orgs_users_overview_performance_index_retrieve(org, user_id, end_date=end_date, format=format, include_main_platform=include_main_platform, start_date=start_date)
print("The response of PerlearnerApi->perlearner_orgs_users_overview_performance_index_retrieve:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling PerlearnerApi->perlearner_orgs_users_overview_performance_index_retrieve: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| org | str | ||
| user_id | str | ||
| end_date | str | end date. ISO 8601 | [optional] |
| format | str | Format * `json` - json | [optional] [default to json] |
| include_main_platform | bool | Include main platform data | [optional] [default to True] |
| start_date | str | start date. ISO 8601 | [optional] |
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
OverTimeWithTotal perlearner_orgs_users_overview_time_over_time_retrieve(org, user_id, end_date=end_date, format=format, include_main_platform=include_main_platform, start_date=start_date)
Time spent in secs on a per-day basis Query Params 1. course_id e.g course-v1:Org+Course4+Run 2. user_id e.g [email protected] or dev123 (username|email) 3. start_date e.g 2020-10-01 4. end_date e.g 2020-10-10 Default result when no query param is added is last_7_days (today inclusive)
- Api Key Authentication (PlatformApiKeyAuthentication):
import iblai
from iblai.models.over_time_with_total import OverTimeWithTotal
from iblai.rest import ApiException
from pprint import pprint
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# The APIs use bearer tokens for authentication with a prefix of: `Api-Key`
# You can generate an authenticated client using the following helper method
client = get_platform_api_client(
host="https://base.manager.iblai.app",
key=os.environ["API_KEY"]
)
# Create an instance of the API class
api_instance = iblai.PerlearnerApi(api_client)
org = 'org_example' # str |
user_id = 'user_id_example' # str |
end_date = 'end_date_example' # str | end date. ISO 8601 (optional)
format = json # str | Format * `json` - json (optional) (default to json)
include_main_platform = True # bool | Include main platform data (optional) (default to True)
start_date = 'start_date_example' # str | start date. ISO 8601 (optional)
try:
api_response = api_instance.perlearner_orgs_users_overview_time_over_time_retrieve(org, user_id, end_date=end_date, format=format, include_main_platform=include_main_platform, start_date=start_date)
print("The response of PerlearnerApi->perlearner_orgs_users_overview_time_over_time_retrieve:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling PerlearnerApi->perlearner_orgs_users_overview_time_over_time_retrieve: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| org | str | ||
| user_id | str | ||
| end_date | str | end date. ISO 8601 | [optional] |
| format | str | Format * `json` - json | [optional] [default to json] |
| include_main_platform | bool | Include main platform data | [optional] [default to True] |
| start_date | str | start date. ISO 8601 | [optional] |
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
PerlearnerUserList perlearner_orgs_users_retrieve(org, format=format, include_main_platform=include_main_platform, length=length, page=page, search=search)
List of entire learners on the platform with aggregated enrollments, completions and time spent
- Api Key Authentication (PlatformApiKeyAuthentication):
import iblai
from iblai.models.perlearner_user_list import PerlearnerUserList
from iblai.rest import ApiException
from pprint import pprint
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# The APIs use bearer tokens for authentication with a prefix of: `Api-Key`
# You can generate an authenticated client using the following helper method
client = get_platform_api_client(
host="https://base.manager.iblai.app",
key=os.environ["API_KEY"]
)
# Create an instance of the API class
api_instance = iblai.PerlearnerApi(api_client)
org = 'org_example' # str |
format = json # str | Format * `json` - json (optional) (default to json)
include_main_platform = True # bool | Include main platform data (optional) (default to True)
length = 56 # int | Size of data to return (optional)
page = 56 # int | Page offset (optional)
search = 'search_example' # str | Search string for learner (optional)
try:
api_response = api_instance.perlearner_orgs_users_retrieve(org, format=format, include_main_platform=include_main_platform, length=length, page=page, search=search)
print("The response of PerlearnerApi->perlearner_orgs_users_retrieve:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling PerlearnerApi->perlearner_orgs_users_retrieve: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| org | str | ||
| format | str | Format * `json` - json | [optional] [default to json] |
| include_main_platform | bool | Include main platform data | [optional] [default to True] |
| length | int | Size of data to return | [optional] |
| page | int | Page offset | [optional] |
| search | str | Search string for learner | [optional] |
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
OverTimeWithTotal perlearner_orgs_users_videos_over_time_retrieve(org, user_id, end_date=end_date, format=format, include_main_platform=include_main_platform, start_date=start_date)
Watched Videos count on a per-day basis Kwargs 1. course_id e.g course-v1:Org+Course4+Run 2. user_id e.g [email protected] or dev123 (username|email) Query Params 3. start_date e.g 2020-10-01 4. end_date e.g 2020-10-10 Default result when no query param is added is last_7_days (today inclusive)
- Api Key Authentication (PlatformApiKeyAuthentication):
import iblai
from iblai.models.over_time_with_total import OverTimeWithTotal
from iblai.rest import ApiException
from pprint import pprint
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# The APIs use bearer tokens for authentication with a prefix of: `Api-Key`
# You can generate an authenticated client using the following helper method
client = get_platform_api_client(
host="https://base.manager.iblai.app",
key=os.environ["API_KEY"]
)
# Create an instance of the API class
api_instance = iblai.PerlearnerApi(api_client)
org = 'org_example' # str |
user_id = 'user_id_example' # str |
end_date = 'end_date_example' # str | end date. ISO 8601 (optional)
format = json # str | Format * `json` - json (optional) (default to json)
include_main_platform = True # bool | Include main platform data (optional) (default to True)
start_date = 'start_date_example' # str | start date. ISO 8601 (optional)
try:
api_response = api_instance.perlearner_orgs_users_videos_over_time_retrieve(org, user_id, end_date=end_date, format=format, include_main_platform=include_main_platform, start_date=start_date)
print("The response of PerlearnerApi->perlearner_orgs_users_videos_over_time_retrieve:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling PerlearnerApi->perlearner_orgs_users_videos_over_time_retrieve: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| org | str | ||
| user_id | str | ||
| end_date | str | end date. ISO 8601 | [optional] |
| format | str | Format * `json` - json | [optional] [default to json] |
| include_main_platform | bool | Include main platform data | [optional] [default to True] |
| start_date | str | start date. ISO 8601 | [optional] |
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
PerlearnerEngagementVideosWatchedPerCourse perlearner_orgs_users_videos_per_course_retrieve(org, user_id, end_date=end_date, format=format, include_main_platform=include_main_platform, start_date=start_date)
Summary Videos watched data for a learner per enrollment Query Params 1. user_id e.g [email protected] or dev123 (username|email)
- Api Key Authentication (PlatformApiKeyAuthentication):
import iblai
from iblai.models.perlearner_engagement_videos_watched_per_course import PerlearnerEngagementVideosWatchedPerCourse
from iblai.rest import ApiException
from pprint import pprint
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# The APIs use bearer tokens for authentication with a prefix of: `Api-Key`
# You can generate an authenticated client using the following helper method
client = get_platform_api_client(
host="https://base.manager.iblai.app",
key=os.environ["API_KEY"]
)
# Create an instance of the API class
api_instance = iblai.PerlearnerApi(api_client)
org = 'org_example' # str |
user_id = 'user_id_example' # str |
end_date = 'end_date_example' # str | end date. ISO 8601 (optional)
format = json # str | Format * `json` - json (optional) (default to json)
include_main_platform = True # bool | Include main platform data (optional) (default to True)
start_date = 'start_date_example' # str | start date. ISO 8601 (optional)
try:
api_response = api_instance.perlearner_orgs_users_videos_per_course_retrieve(org, user_id, end_date=end_date, format=format, include_main_platform=include_main_platform, start_date=start_date)
print("The response of PerlearnerApi->perlearner_orgs_users_videos_per_course_retrieve:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling PerlearnerApi->perlearner_orgs_users_videos_per_course_retrieve: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| org | str | ||
| user_id | str | ||
| end_date | str | end date. ISO 8601 | [optional] |
| format | str | Format * `json` - json | [optional] [default to json] |
| include_main_platform | bool | Include main platform data | [optional] [default to True] |
| start_date | str | start date. ISO 8601 | [optional] |
PerlearnerEngagementVideosWatchedPerCourse
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]