Skip to content

/

/

ai_analytics_engagement_orgs_courses_videos_summary_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_videos_over_time_retrieve

Request

Get video watch counts over time.

This endpoint provides daily counts of videos watched over a specified time period, with options to filter by course or user.

Query Parameters: start_date (str, optional): Start date for the time range (ISO format) end_date (str, optional): End date for the time range (ISO format) course_id (str, optional): Filter by course ID user_id (str, optional): Filter by username or email

Returns: Daily video watch counts over the specified time period.

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

Access Control:

Platform admins can access any video watch data
Learners can access their own video watch data

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

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}/videos/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_analytics_engagement_orgs_courses_videos_summary_retrieve

Request

Get a summary of video watch statistics for a specific course.

This endpoint provides a structured summary of video watch data for a course, organized in a tree-like format by course sections and subsections.

Query Parameters: course_id (str): The course ID to get video summary for

Returns: A hierarchical structure of video watch data for the course, including:

Section and subsection organization
Video identification and metadata
Watch counts and completion rates

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

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/ai-analytics/engagement/orgs/{org}/courses/{course_id}/videos/summary?department_id=0&format=json&include_main_platform=true' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json

dataArray of objects(VideosInCourseSummaryData)

Response

application/json

{
  "data": [
    { … }
  ]
}

ai_analytics_engagement_orgs_courses_videos_users_retrieve

Request

List of users' videos completed records for a specific course

Kwargs 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

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/ai-analytics/engagement/orgs/{org}/courses/{course_id}/videos/users?department_id=0&format=json&include_main_platform=true' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json

dataArray of objects(WatchedVideosPerUserData)

totalinteger

Total rows

Response

application/json

{
  "data": [
    { … }
  ],
  "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