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

ai_analytics_overview_orgs_courses_completions_retrieve

Request

Get course completion summary metrics over time.

This endpoint provides completion statistics across the platform over a specified time period, including daily completion counts and overall metrics.

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

Returns: Completion data including:

  • Daily completion counts over time
  • Total unique user count
  • Total completion count
  • Completion percentage
  • Change metrics compared to previous periods

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

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/ai-analytics/overview/orgs/{org}/courses/completions?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(CourseCompletionSummaryDataOvertime)required
data.​overtimeobject

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

data.​total_user_countintegerrequired

Total unique active users in this period

data.​completed_countintegerrequired

Total course completions

data.​completed_percentnumber(double)required

Completion percent for the time range

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": {
    "overtime": { … },
    "total_user_count": 0,
    "completed_count": 0,
    "completed_percent": 0.1
  },
  "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_analytics_overview_orgs_learners_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/ai-analytics/overview/orgs/{org}/learners?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_analytics_overview_orgs_most_active_courses_retrieve

Request

Get time spent statistics on a per-course basis.

This endpoint provides a paginated list of courses with the total time spent by users in each course.

Query Parameters: start_date (str, optional): Start date for filtering (ISO format) end_date (str, optional): End date for filtering (ISO format) page (int, optional): Page number for pagination length (int, optional): Number of items per page

Returns: A paginated list of courses with:

  • Course identification (ID and name)
  • Total time spent (in seconds)
  • Formatted time spent (human-readable)
  • Percentage of total platform time
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
lengthinteger

Size of data to return

pageinteger

Page offset

start_datestringnon-empty

start date. ISO 8601

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

Responses

Bodyapplication/json
dataArray of objects(TimeSpentPerCourseData)
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
Copyright © ibl.ai | support@iblai.zendesk.com