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

platform_orgs_courses_users_progress_days_to_complete_retrieve

Request

Average days used to complete a course

Query Params

  1. course_id e.g course-v1:Org+Course4+Run
Security
PlatformApiKeyAuthentication
Path
course_idstring^((\w*)-(\w*):[^+]+(|\+)[^+]+(|\+)\+\w+)$required
orgstringrequired
user_idstringrequired
curl -i -X GET \
  'https://docs.ibl.ai/_mock/apis/ibl/api/platform/orgs/{org}/courses/{course_id}/users/{user_id}/progress/days-to-complete' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

No response body

platform_orgs_courses_users_time_count_retrieve

Request

Time spent count in seconds within a course by a learner

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/platform/orgs/{org}/courses/{course_id}/users/{user_id}/time/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(CountData)required
data.​countintegerrequired

Total

Response
application/json
{
  "data": {
    "count": 0
  }
}

platform_orgs_courses_users_videos_count_retrieve

Request

(Total videos watched / Total Course Videos) or Total Videos watched in a course by a learner

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

formatstringnon-empty

Format

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

Include main platform data

Default true
curl -i -X GET \
  'https://docs.ibl.ai/_mock/apis/ibl/api/platform/orgs/{org}/courses/{course_id}/users/{user_id}/videos/count?department_id=0&format=json&include_main_platform=true' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json
dataobject(VideosCountData)
Response
application/json
{
  "data": {
    "count": "string"
  }
}

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