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

roles_platform_orgs_roles_users_reported_roles_retrieve

Request

Retrieve a user's reported role information.

This endpoint returns the role and skills that a user has reported having in their profile. This represents the user's current skills and professional role.

Path Parameters: org (str): The platform/organization identifier username (str): The username of the user to retrieve role information for

Returns: The user's reported role information including:

  • Role title
  • Skills associated with the role
  • Experience level

Error Responses: 400 Bad Request: If the user doesn't exist in the platform or has no reported role 404 Not Found: If the specified platform doesn't exist

Security
PlatformApiKeyAuthentication
Path
orgstringrequired
usernamestringrequired
curl -i -X GET \
  'https://docs.ibl.ai/_mock/apis/ibl/api/roles/platform/orgs/{org}/roles/users/{username}/reported-roles/' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json
user_idinteger
usernamestring
rolesArray of objects(Role)required
roles[].​idintegerread-onlyrequired
roles[].​namestring or nullread-onlyrequired

The display name of the role.

roles[].​slugstring or nullread-onlyrequired

An additional unique slug field.

roles[].​platform_keystring
roles[].​skillsArray of objects(Skill)required
roles[].​skills[].​idintegerread-onlyrequired
roles[].​skills[].​namestring or nullread-onlyrequired

Display name

roles[].​skills[].​platform_keystring
roles[].​skills[].​slugstring or null^[-a-zA-Z0-9_]+$read-onlyrequired

An additional unique slug field. (Optional)

roles[].​skills[].​dataany or nullread-onlyrequired

Metadata

roles[].​dataany or nullread-onlyrequired

Metadata

dataany or nullread-onlyrequired
Response
application/json
{ "user_id": 0, "username": "string", "roles": [ {} ], "data": null }

user_groups_orgs_retrieve

Request

Get a list of user groups with metrics and filtering options.

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

This endpoint uses DM token authentication and respects department-based access controls.

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 groups (list, optional): Filter by group names location (str, optional): Filter by location is_enrolled (bool, optional): Filter for groups 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 user groups with comprehensive metrics.

Access Control:

  • Platform admins can see all groups
  • Department admins can only see groups in their departments
Security
PlatformApiKeyAuthentication
Path
keystringrequired
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)

Filter by learners date_joined. Start date. ISO 8601

formatstringnon-empty

Format

  • json - json
Default "json"
Value"json"
groupsArray of strings

Groups search string. Single string or list of strings. e.g 'sample_group' or ['group', 'another group']

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

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/user-groups/orgs/{key}/?department_id=0&end_date=2019-08-24&format=json&groups=string&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