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

platform_orgs_courses_progress_started_retrieve

Request

Started means an enrollment

For platform : Total users who have atleast an enrollment For course : Total users enrolled For learner : Total courses in progress

Query Params

  1. course_id e.g course-v1:Org+Course4+Run
  2. user_id e.g developer@ibleducation.com or dev123 (username|email)
Security
PlatformApiKeyAuthentication
Path
course_idstring^((\w*)-(\w*):[^+]+(|\+)[^+]+(|\+)\+\w+)$required
orgstringrequired
curl -i -X GET \
  'https://docs.ibl.ai/_mock/apis/ibl/api/platform/orgs/{org}/courses/{course_id}/progress/started' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

No response body

platform_orgs_courses_users_grades_passed_retrieve

Request

Base class for API views that return a single count value.

This class formats the response as {"data": {value_key: count}} where value_key is configurable (defaults to "count").

Attributes: value_key: The key used in the response for the count value

Security
PlatformApiKeyAuthentication
Path
course_idstring^((\w*)-(\w*):[^+]+(|\+)[^+]+(|\+)\+\w+)$required
orgstringrequired
user_idstringrequired
curl -i -X GET \
  'https://docs.ibl.ai/_mock/apis/ibl/api/platform/orgs/{org}/courses/{course_id}/users/{user_id}/grades/passed' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

No response body

platform_orgs_courses_users_progress_retrieve

Request

Gives Percentage of units completed in course for a specific learner

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

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/platform/orgs/{org}/courses/{course_id}/users/{user_id}/progress?department_id=0&format=json&include_main_platform=true' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json
dataobject(PerlearnerCourseProgressData)required
data.​progressnumber(double)required

Perlearner Course progress

Response
application/json
{
  "data": {
    "progress": 0.1
  }
}

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