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

engagement_orgs_videos_retrieve

Request

Get video engagement metrics on a per-course basis.

This endpoint provides a paginated list of courses with video engagement metrics including view counts, completion rates, and time spent on videos.

Query Parameters: page (int, optional): Page number for pagination length (int, optional): Number of items per page

Returns: A paginated list of courses with their video engagement 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

curl -i -X GET \
  'https://docs.ibl.ai/_mock/apis/ibl/api/engagement/orgs/{org}/videos/?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(VideoEngagementPerCourseData)
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 } }

engagement_orgs_videos_over_time_retrieve

Request

Get video watch counts over time.

This endpoint provides daily counts of videos watched over a specified time period, with options to filter by course or user.

Query Parameters: start_date (str, optional): Start date for the time range (ISO format) end_date (str, optional): End date for the time range (ISO format) course_id (str, optional): Filter by course ID user_id (str, optional): Filter by username or email

Returns: Daily video watch counts over the specified time period.

Default time range is the last 7 days if no dates are specified.

Access Control:

  • Platform admins can access any video watch data
  • Learners can access their own video watch data
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_datestringnon-empty

end date. ISO 8601

formatstringnon-empty

Format

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

Include main platform data

Default true
start_datestringnon-empty

start date. ISO 8601

curl -i -X GET \
  'https://docs.ibl.ai/_mock/apis/ibl/api/engagement/orgs/{org}/videos/over-time?department_id=0&end_date=string&format=json&include_main_platform=true&start_date=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json
dataobject

Dates are keys and values are the value for the date in the key. e,g {"2020-01-01": 30. ...}

totalinteger

Total

Response
application/json
{ "data": { "property1": null, "property2": null }, "total": 0 }

overview_orgs_active_users_retrieve

Request

Get active user counts over time.

This endpoint provides daily counts of active users (users with known activity) over a specified time period.

Query Parameters: start_date (str, optional): Start date for the time range (ISO format) end_date (str, optional): End date for the time range (ISO format)

Returns: Daily active user counts over the specified time period, with change metrics compared to previous periods.

Default time range is the last 7 days if no dates are specified.

An active user is defined as a user with any activity within the past 30 days.

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_datestringnon-empty

end date. ISO 8601

formatstringnon-empty

Format

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

Include main platform data

Default true
start_datestringnon-empty

start date. ISO 8601

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

Responses

Bodyapplication/json
dataobject

Dates are keys and values are the value for the date in the key. e,g {"2020-01-01": 30. ...}

totalinteger

Total

metaobject(OvertimeMeta)required
meta.​totalintegerrequired

Total records

meta.​change_rangeinteger

Change in range

Default 0
meta.​change_last_seven_daysinteger

Change in last 7 days

Default 0
meta.​change_last_thirty_daysinteger

Change in last 30 days

Default 0
meta.​change_last_seven_days_percentnumber(double)

Change in last 7 days in percentage

Default 0
meta.​change_last_thirty_days_percentnumber(double)

Change in last 30 days in percentage

Default 0
meta.​change_range_percentnumber(double)

Change in range in percentage

Response
application/json
{ "data": { "property1": null, "property2": null }, "total": 0, "meta": { "total": 0, "change_range": 0, "change_last_seven_days": 0, "change_last_thirty_days": 0, "change_last_seven_days_percent": 0, "change_last_thirty_days_percent": 0, "change_range_percent": 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