Skip to content

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

API for iblai

Download OpenAPI description
Languages
Servers
Mock server

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

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

ai-account

Operations

ai-analytics

Operations

performance_orgs_grading_per_course_retrieve

Request

List grade-related performance data for all courses.

This endpoint provides a comprehensive view of grade performance across courses, including enrollment counts, pass rates, and average grades.

Returns: A paginated list of courses with:

  • Course identification (ID and name)
  • Enrollment count
  • Number of students who passed
  • Average grade
Security
PlatformApiKeyAuthentication
Path
orgstringrequired
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
lengthinteger

Size of data to return

pageinteger

Page offset

curl -i -X GET \
  'https://docs.ibl.ai/_mock/apis/ibl/api/performance/orgs/{org}/grading/per-course?department_id=0&format=json&include_main_platform=true&length=0&page=0' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json
dataArray of objects(PerformanceGradesPerCourseData)
paginationobject(Pagination)required
pagination.​totalItemsintegerrequired

Total records

pagination.​currentPageintegerrequired

Current Page

pagination.​perPageintegerrequired

Size of data returned per page

pagination.​totalPagesintegerrequired

Amount of pages

Response
application/json
{ "data": [ {} ], "pagination": { "totalItems": 0, "currentPage": 0, "perPage": 0, "totalPages": 0 } }

perlearner_orgs_learners_retrieve

Request

Enhanced API endpoint for listing learners with comprehensive filtering.

This endpoint provides a paginated list of learners with detailed metrics and supports advanced filtering options. It uses DM token authentication and respects department-based access controls.

Query Parameters: page (int): Page number for pagination length (int): Number of items per page search (str): Filter by username, email, or full name program (str): Filter by program location (str): Filter by location is_enrolled (bool): Filter for users with enrollments platform (str): Filter by platform start_date (date): Filter by join date (start range) end_date (date): Filter by join date (end range)

Returns: A paginated list of learners with comprehensive metrics including:

  • Course enrollments and completions
  • Time spent on platform
  • Pathway progress
  • Certificate and skill information
  • Location data

Access Control:

  • Platform admins can see all learners
  • Department admins can only see learners in their departments
Security
PlatformApiKeyAuthentication
Path
orgstringrequired
Query
department_idinteger

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

end_datestring(date)

Learner date_joined end date. ISO 8601

formatstringnon-empty

Format

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

Include main platform data

Default true
is_enrolledboolean or null

Filter for users who have at least an enrollment

lengthinteger

Size of data to return

locationstringnon-empty

Location search string

pageinteger

Page offset

platformstringnon-empty

Platform search string

programstringnon-empty

Program search string

searchstringnon-empty

Search string for learner. email, username or full name

start_datestring(date)

Learner date_joined start date. ISO 8601

curl -i -X GET \
  'https://docs.ibl.ai/_mock/apis/ibl/api/perlearner/orgs/{org}/learners?department_id=0&end_date=2019-08-24&format=json&include_main_platform=true&is_enrolled=true&length=0&location=string&page=0&platform=string&program=string&search=string&start_date=2019-08-24' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json
dataArray of objects(NewPerLearnerListData)
paginationobject(Pagination)required
pagination.​totalItemsintegerrequired

Total records

pagination.​currentPageintegerrequired

Current Page

pagination.​perPageintegerrequired

Size of data returned per page

pagination.​totalPagesintegerrequired

Amount of pages

Response
application/json
{ "data": [ {} ], "pagination": { "totalItems": 0, "currentPage": 0, "perPage": 0, "totalPages": 0 } }

perlearner_orgs_users_retrieve

Request

List all learners on the platform with aggregated metrics.

This endpoint returns a paginated list of all learners with key metrics including:

  • Enrollment counts
  • Completion counts
  • Time spent on platform

Query Parameters: page (int): Page number for pagination length (int): Number of items per page search (str): Filter learners by username, email, or name

Returns: A paginated list of learners with their associated metrics.

Security
PlatformApiKeyAuthentication
Path
orgstringrequired
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
lengthinteger

Size of data to return

pageinteger

Page offset

searchstringnon-empty

Search string for learner

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

Responses

Bodyapplication/json
dataArray of objects(PerlearnerUserListData)
paginationobject(Pagination)required
pagination.​totalItemsintegerrequired

Total records

pagination.​currentPageintegerrequired

Current Page

pagination.​perPageintegerrequired

Size of data returned per page

pagination.​totalPagesintegerrequired

Amount of pages

Response
application/json
{ "data": [ {} ], "pagination": { "totalItems": 0, "currentPage": 0, "perPage": 0, "totalPages": 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

skills

Operations