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

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

core_users_proxy_bulk_create

Request

Add proxy users by bulk

Params: users: list of user objects

[
    {"user_id": 1, ...},
    {"user_id": 2, ...}
]
Security
PlatformApiKeyAuthentication
Bodyrequired
usersArray of objectsrequired
users[].​property name*stringadditional property
curl -i -X POST \
  https://docs.ibl.ai/_mock/apis/ibl/api/core/users/proxy/bulk/ \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "users": [
      {
        "user_id": 1,
        "username": "test_user1",
        "email": "test_user1@example.com"
      },
      {
        "user_id": 2,
        "username": "test_user2",
        "email": "test_user2@example.com"
      }
    ]
  }'

Responses

Bodyapplication/jsonArray [
property name*stringadditional property
]
Response
application/json
[ [ {}, {} ] ]

core_users_search_retrieve

Request

Retrieve users based on query Not intended for public use with multitenant platforms

Params: query sort

Security
PlatformApiKeyAuthentication
Query
pageinteger
page_sizeinteger
querystringnon-empty
sortstringnon-empty
curl -i -X GET \
  'https://docs.ibl.ai/_mock/apis/ibl/api/core/users/search/?page=0&page_size=0&query=string&sort=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json
countintegerrequired
next_pageintegerrequired
previous_pageintegerrequired
resultsArray of objectsrequired
results[].​property name*anyadditional property
Response
application/json
{ "count": 35, "next_page": 4, "previous_page": 2, "results": [ {}, {}, {} ] }

departments_orgs_retrieve

Request

Get a list of departments with metrics and filtering options.

This endpoint provides a paginated list of departments with aggregated metrics about learner performance, course completions, and skill acquisition.

Query Parameters: page (int, optional): Page number for pagination length (int, optional): Number of items per page program (str, optional): Filter by program pathway (str, optional): Filter by pathway departments (list, optional): Filter by department ids department_id (str, optional): Filter by department id location (str, optional): Filter by location is_enrolled (bool, optional): Filter for departments with enrolled users start_date (date, optional): Filter by learner join date (start range) end_date (date, optional): Filter by learner join date (end range)

Returns: A paginated list of departments with comprehensive 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

departmentsArray of strings

Departments search string. Single string or list of strings. e.g 'sample_department' or ['department', 'another department']

end_datestring(date)

Filter by learners date_joined. Start 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 enro;lment

lengthinteger

Size of data to return

locationstringnon-empty

Location search string

pageinteger

Page offset

pathwaystringnon-empty

Pathway string

programstringnon-empty

Program search string

start_datestring(date)

Filter by learners date_joined. Start date. ISO 8601

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

Responses

Bodyapplication/json
dataArray of objects(GroupListData)
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 } }

credentials

Operations

features

Operations

media

Operations

notifications

Operations

scim

Operations

commerce

Operations

recommendations

Operations

reports

Operations

skills

Operations