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/

Operations
Operations

platform_orgs_progress_started_retrieve

Request

Started means an enrollment

For platform : Total users who have atleast an enrollment For course : Total users enrolled For learner : Total courses in progress

Query Params

  1. course_id e.g course-v1:Org+Course4+Run
  2. user_id e.g developer@ibleducation.com or dev123 (username|email)
Security
PlatformApiKeyAuthentication
Path
orgstringrequired
curl -i -X GET \
  'https://docs.ibl.ai/_mock/apis/ibl/api/platform/orgs/{org}/progress/started' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

No response body

Request

Total time spent count on the platform within specified range or all time

Query Params

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

Default result is all time

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

Responses

No response body

platform_orgs_users_active_count_retrieve

Request

Get count of active users on the platform.

This endpoint returns the number of users who have had activity on the platform, either for all time or within a specified date range.

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

Returns: The count of active users and change metrics compared to previous periods.

Default behavior returns the count for all time if no date range is 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/platform/orgs/{org}/users/active/count?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 }
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations