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

audience_orgs_registered_users_per_course_retrieve

Request

List enrollment statistics on a per-course basis.

This endpoint provides enrollment counts for all courses, with options to filter for active or inactive enrollments and to include time-based data.

Query Parameters: active (bool): Filter for active enrollments when true, inactive when false start_date (str, optional): Start date for time-based filtering (ISO format) end_date (str, optional): End date for time-based 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 their enrollment counts and percentages.

Security
PlatformApiKeyAuthentication
Path
orgstringrequired
Query
activestringnon-empty

Any of y, yes, true. set to false or no for unenrollments

  • y - y
  • yes - yes
  • true - true
  • True - True
  • n - n
  • no - no
  • false - false
  • False - False
Default "y"
Enum"y""yes""true""True""n""no""false""False"
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/audience/orgs/{org}/registered-users/per-course?active=y&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(EnrollmentsData)
paginationobject(Pagination)required
pagination.​totalItemsintegerrequired

Total records

pagination.​currentPageintegerrequired

Current Page

pagination.​perPageintegerrequired

Size of data returned per page

pagination.​totalPagesintegerrequired

Amount of pages

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

engagement_orgs_activity_retrieve

Request

Get engagement metrics on a per-course basis.

This endpoint provides a paginated list of courses with engagement metrics including activity counts, time spent, and interaction data.

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 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}/activity?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(EngagementPerCourseData)
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_course_completion_over_time_retrieve

Request

Completion count per user per course across the platform

Query Params

  1. start_date e.g 2020-10-01
  2. end_date e.g 2020-10-10

Default result when no query param is added is last_7_days (today inclusive)

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}/course_completion/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

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
Copyright © ibl.ai | support@iblai.zendesk.com