Skip to content

/

/

ai_analytics_engagement_orgs_courses_time_users_detail_retrieve

ibl-data-manager (3.59.0-ai-plus)

API for iblai

Download OpenAPI description

Servers

Mock server

https://docs.ibl.ai/_mock/apis/ibl/

https://base.manager.iblai.app/

ai-account

Operations

ai-analytics

Operations

ai_analytics_engagement_orgs_courses_time_users_retrieve

Request

Time spent by users in a course

Query Params course_id e.g course-v1:Org+Course4+Run

Security

PlatformApiKeyAuthentication

Path

course_idstring^((\w*)-(\w*):[^+]+(|\+)[^+]+(|\+)\+\w+)$required

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/engagement/orgs/{org}/courses/{course_id}/time/users?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(TimeSpentByUsersInCourseData)

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_engagement_orgs_courses_time_users_detail_retrieve

Request

Time spent within a course in ordered hierarchical format

Kwargs

course_id e.g course-v1:Org+Course4+Run
user_id e.g developer@ibleducation.com or dev123 (username|email) Query Params
start_date e.g 2020-10-01
end_date e.g 2020-10-10

Security

PlatformApiKeyAuthentication

Path

course_idstring^((\w*)-(\w*):[^+]+(|\+)[^+]+(|\+)\+\w+)$required

orgstringrequired

user_idstringrequired

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/engagement/orgs/{org}/courses/{course_id}/time/users/{user_id}/detail?department_id=0&end_date=string&format=json&include_main_platform=true&start_date=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json

dataArray of objects(TimeChildData)

totalinteger

Total time spent

Response

application/json

{
  "data": [
    { … }
  ],
  "total": 0
}

ai_analytics_engagement_orgs_courses_time_users_over_time_retrieve

Request

Time spent in secs on a per-day basis

Query Params

course_id e.g course-v1:Org+Course4+Run
user_id e.g developer@ibleducation.com or dev123 (username|email)
start_date e.g 2020-10-01
end_date e.g 2020-10-10

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

Security

PlatformApiKeyAuthentication

Path

course_idstring^((\w*)-(\w*):[^+]+(|\+)[^+]+(|\+)\+\w+)$required

orgstringrequired

user_idstringrequired

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/engagement/orgs/{org}/courses/{course_id}/time/users/{user_id}/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
}

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

search

Operations

skills

Operations