@iblai/iblai-api 3.34.5-core

package/dist/types/models/VideoEngagementPerCourseData.d.ts

@@ -0,0 +1,30 @@
+export type VideoEngagementPerCourseData = {
+    /**
+     * Course name
+     */
+    name: string;
+    /**
+     * edx Course Id
+     */
+    course_id: string;
+    /**
+     * Number of videos in course
+     */
+    num_vids: number;
+    /**
+     * Number of videos watched
+     */
+    num_watched: number;
+    /**
+     * Total time spent by all users watching videos
+     */
+    time_watched: number;
+    /**
+     * Average percentage of videos watched per user per course
+     */
+    avg_percent_watched: number;
+    /**
+     * Average time spent per learner
+     */
+    avg_time_watched: number;
+};

package/dist/types/models/VideosCount.d.ts

@@ -0,0 +1,4 @@
+import type { VideosCountData } from './VideosCountData';
+export type VideosCount = {
+    data?: VideosCountData;
+};

package/dist/types/models/VideosCountData.d.ts

@@ -0,0 +1,6 @@
+export type VideosCountData = {
+    /**
+     * Total videos (videos watched / Total Course Videos)
+     */
+    count: string;
+};

package/dist/types/models/VideosInCourseSummary.d.ts

@@ -0,0 +1,4 @@
+import type { VideosInCourseSummaryData } from './VideosInCourseSummaryData';
+export type VideosInCourseSummary = {
+    data?: Array<VideosInCourseSummaryData>;
+};

package/dist/types/models/VideosInCourseSummaryData.d.ts

@@ -0,0 +1,12 @@
+import type { VideosWatchedSubSection } from './VideosWatchedSubSection';
+export type VideosInCourseSummaryData = {
+    /**
+     * Chapter name
+     */
+    display_name: string;
+    /**
+     * Chapter Id
+     */
+    id: string;
+    subsections?: Array<VideosWatchedSubSection>;
+};

package/dist/types/models/VideosSpecificCourse.d.ts

@@ -0,0 +1,4 @@
+import type { VideosSpecificCourseData } from './VideosSpecificCourseData';
+export type VideosSpecificCourse = {
+    data?: Array<VideosSpecificCourseData>;
+};

package/dist/types/models/VideosSpecificCourseData.d.ts

@@ -0,0 +1,26 @@
+export type VideosSpecificCourseData = {
+    /**
+     * Course name
+     */
+    display_name: string;
+    /**
+     * Video Id
+     */
+    id: string;
+    /**
+     * Video duration
+     */
+    duration: number;
+    /**
+     * Total time spent by users watching
+     */
+    total_time: number;
+    /**
+     * Total users who have watched this video
+     */
+    total_users: number;
+    /**
+     * Average time spent per learner
+     */
+    average_time: number;
+};

package/dist/types/models/VideosWatchedSubSection.d.ts

@@ -0,0 +1,19 @@
+import type { VideoBlock } from './VideoBlock';
+export type VideosWatchedSubSection = {
+    /**
+     * Subsection name
+     */
+    display_name: string;
+    /**
+     * Subsection Id
+     */
+    id: string;
+    /**
+     * Total videos watched. N/A if no record found
+     */
+    total_watch: string;
+    /**
+     * Videos
+     */
+    videos?: Array<VideoBlock>;
+};

package/dist/types/models/WatchedVideosPerUser.d.ts

@@ -0,0 +1,8 @@
+import type { WatchedVideosPerUserData } from './WatchedVideosPerUserData';
+export type WatchedVideosPerUser = {
+    data?: Array<WatchedVideosPerUserData>;
+    /**
+     * Total rows
+     */
+    total?: number;
+};

package/dist/types/models/WatchedVideosPerUserData.d.ts

@@ -0,0 +1,18 @@
+export type WatchedVideosPerUserData = {
+    /**
+     * learner username
+     */
+    username: string;
+    /**
+     * learner fullname
+     */
+    full_name: string;
+    /**
+     * Videos watched count
+     */
+    count: number;
+    /**
+     * Percentage ...
+     */
+    percentage: number;
+};

package/dist/types/services/AnalyticsService.d.ts

@@ -0,0 +1,51 @@
+import type { TimeSpentPerUserResponse } from '../models/TimeSpentPerUserResponse';
+import type { TimeSpentUpdateRequest } from '../models/TimeSpentUpdateRequest';
+import type { TimeSpentUpdateResponse } from '../models/TimeSpentUpdateResponse';
+import type { CancelablePromise } from '../core/CancelablePromise';
+export declare class AnalyticsService {
+    /**
+     * Update time spent tracking data from client-side events.
+     *
+     * This endpoint receives time spent data collected on the client side and
+     * stores it in the analytics database. It requires a valid authentication token.
+     *
+     * Methods:
+     * POST: Submit time spent tracking data
+     *
+     *
+     *
+     * Returns:
+     * A response indicating success or failure:
+     * {
+         * "success": true|false,
+         * "message": "Error message if failed" (optional)
+         * }
+         *
+         * Error Responses:
+         * 400 Bad Request: If the request data is invalid or the API is disabled
+         *
+         * Notes:
+         * This API must be enabled via the ENABLE_TIME_SPENT_UPDATE_API setting.
+         * @param org
+         * @param requestBody
+         * @returns TimeSpentUpdateResponse
+         * @throws ApiError
+         */
+    static analyticsOrgsTimeUpdateCreate(org: string, requestBody: TimeSpentUpdateRequest): CancelablePromise<TimeSpentUpdateResponse>;
+    /**
+     * Get total time spent for current user
+     *
+     * Returns the total time spent (in seconds) for the current authenticated user.
+     * Can be filtered by platform, date range, course ID, and URL.
+     *
+     * @param courseId Course ID to filter by (can be partial)
+     * @param endDate End date for time range (YYYY-MM-DD)
+     * @param includeMainPlatform Whether to include main platform data
+     * @param platform Platform name or key to filter by
+     * @param startDate Start date for time range (YYYY-MM-DD)
+     * @param url URL to filter by (can be partial)
+     * @returns TimeSpentPerUserResponse
+     * @throws ApiError
+     */
+    static analyticsTimeSpentUserRetrieve(courseId?: string, endDate?: string, includeMainPlatform?: boolean, platform?: string, startDate?: string, url?: string): CancelablePromise<TimeSpentPerUserResponse>;
+}

package/dist/types/services/AudienceService.d.ts

@@ -0,0 +1,348 @@
+import type { ActiveUsersList } from '../models/ActiveUsersList';
+import type { ActiveUsersPerCourse } from '../models/ActiveUsersPerCourse';
+import type { Enrollments } from '../models/Enrollments';
+import type { EnrollmentsPerUser } from '../models/EnrollmentsPerUser';
+import type { OvertimeWithChangeInfo } from '../models/OvertimeWithChangeInfo';
+import type { PerlearnerUserList } from '../models/PerlearnerUserList';
+import type { CancelablePromise } from '../core/CancelablePromise';
+export declare class AudienceService {
+    /**
+     * Get active user counts over time.
+     *
+     * This endpoint provides daily counts of active users (users with known activity)
+     * over a specified time period.
+     *
+     * 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)
+     *
+     * Returns:
+     * Daily active user counts over the specified time period, with change metrics
+     * compared to previous periods.
+     *
+     * Default time range is the last 7 days if no dates are specified.
+     *
+     * An active user is defined as a user with any activity within the past 30 days.
+     * @param org
+     * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
+     * @param endDate end date. ISO 8601
+     * @param format Format
+     *
+     * * `json` - json
+     * @param includeMainPlatform Include main platform data
+     * @param startDate start date. ISO 8601
+     * @returns OvertimeWithChangeInfo
+     * @throws ApiError
+     */
+    static audienceOrgsActiveUsersOverTimeRetrieve(org: string, departmentId?: number, endDate?: string, format?: 'json', includeMainPlatform?: boolean, startDate?: string): CancelablePromise<OvertimeWithChangeInfo>;
+    /**
+     * Get active user counts on a per-course basis.
+     *
+     * This endpoint provides counts of active users for each course within
+     * the 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:
+     * A list of courses with their active user counts.
+     *
+     * Default time range is the last 7 days if no dates are specified.
+     * @param org
+     * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
+     * @param endDate end date. ISO 8601
+     * @param format Format
+     *
+     * * `json` - json
+     * @param includeMainPlatform Include main platform data
+     * @param startDate start date. ISO 8601
+     * @returns ActiveUsersPerCourse
+     * @throws ApiError
+     */
+    static audienceOrgsActiveUsersPerCourseRetrieve(org: string, departmentId?: number, endDate?: string, format?: 'json', includeMainPlatform?: boolean, startDate?: string): CancelablePromise<ActiveUsersPerCourse>;
+    /**
+     * Get a list of active users with activity metrics.
+     *
+     * This endpoint provides a paginated list of users who have had activity
+     * within the 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)
+     * course_id (str, optional): Filter by course ID
+     * page (int, optional): Page number for pagination
+     * length (int, optional): Number of items per page
+     *
+     * Returns:
+     * A paginated list of active users with their activity metrics.
+     *
+     * Default time range is the last 7 days if no dates are specified.
+     * @param org
+     * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
+     * @param format Format
+     *
+     * * `json` - json
+     * @param includeMainPlatform Include main platform data
+     * @param length Size of data to return
+     * @param page Page offset
+     * @returns ActiveUsersList
+     * @throws ApiError
+     */
+    static audienceOrgsActiveUsersUsersRetrieve(org: string, departmentId?: number, format?: 'json', includeMainPlatform?: boolean, length?: number, page?: number): CancelablePromise<ActiveUsersList>;
+    /**
+     * Get enrollment or unenrollment counts over time.
+     *
+     * This endpoint provides daily counts of new enrollments or unenrollments
+     * over a specified time period.
+     *
+     * 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
+     * active (bool): Get enrollments when true, unenrollments when false
+     *
+     * Returns:
+     * Daily counts over the specified time period, with change metrics
+     * compared to previous periods.
+     *
+     * Default time range is the last 7 days if no dates are specified.
+     * @param courseId
+     * @param org
+     * @param active 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
+     * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
+     * @param endDate end date. ISO 8601
+     * @param format Format
+     *
+     * * `json` - json
+     * @param includeMainPlatform Include main platform data
+     * @param startDate start date. ISO 8601
+     * @returns OvertimeWithChangeInfo
+     * @throws ApiError
+     */
+    static audienceOrgsEnrollmentsCoursesOverTimeRetrieve(courseId: string, org: string, active?: 'y' | 'yes' | 'true' | 'True' | 'n' | 'no' | 'false' | 'False', departmentId?: number, endDate?: string, format?: 'json', includeMainPlatform?: boolean, startDate?: string): CancelablePromise<OvertimeWithChangeInfo>;
+    /**
+     * List users enrolled in a specific course.
+     *
+     * This endpoint provides a list of users who are enrolled or unenrolled
+     * in a specified course.
+     *
+     * Query Parameters:
+     * course_id (str): The course ID to get enrollments for
+     * active (bool): Filter for active enrollments when true, inactive when false
+     * page (int, optional): Page number for pagination
+     * length (int, optional): Number of items per page
+     *
+     * Returns:
+     * A paginated list of users with:
+     * - Username
+     * - Full name
+     * - Email
+     * - Enrollment timestamp
+     * @param courseId
+     * @param org
+     * @param active 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
+     * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
+     * @param endDate end date. ISO 8601
+     * @param format Format
+     *
+     * * `json` - json
+     * @param includeMainPlatform Include main platform data
+     * @param length Size of data to return
+     * @param page Page offset
+     * @param startDate start date. ISO 8601
+     * @returns EnrollmentsPerUser
+     * @throws ApiError
+     */
+    static audienceOrgsEnrollmentsCoursesUsersRetrieve(courseId: string, org: string, active?: 'y' | 'yes' | 'true' | 'True' | 'n' | 'no' | 'false' | 'False', departmentId?: number, endDate?: string, format?: 'json', includeMainPlatform?: boolean, length?: number, page?: number, startDate?: string): CancelablePromise<EnrollmentsPerUser>;
+    /**
+     * Get enrollment or unenrollment counts over time.
+     *
+     * This endpoint provides daily counts of new enrollments or unenrollments
+     * over a specified time period.
+     *
+     * 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
+     * active (bool): Get enrollments when true, unenrollments when false
+     *
+     * Returns:
+     * Daily counts over the specified time period, with change metrics
+     * compared to previous periods.
+     *
+     * Default time range is the last 7 days if no dates are specified.
+     * @param org
+     * @param active 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
+     * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
+     * @param endDate end date. ISO 8601
+     * @param format Format
+     *
+     * * `json` - json
+     * @param includeMainPlatform Include main platform data
+     * @param startDate start date. ISO 8601
+     * @returns OvertimeWithChangeInfo
+     * @throws ApiError
+     */
+    static audienceOrgsEnrollmentsOverTimeRetrieve(org: string, active?: 'y' | 'yes' | 'true' | 'True' | 'n' | 'no' | 'false' | 'False', departmentId?: number, endDate?: string, format?: 'json', includeMainPlatform?: boolean, startDate?: string): CancelablePromise<OvertimeWithChangeInfo>;
+    /**
+     * 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.
+     * @param org
+     * @param active 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
+     * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
+     * @param endDate end date. ISO 8601
+     * @param format Format
+     *
+     * * `json` - json
+     * @param includeMainPlatform Include main platform data
+     * @param length Size of data to return
+     * @param page Page offset
+     * @param startDate start date. ISO 8601
+     * @returns Enrollments
+     * @throws ApiError
+     */
+    static audienceOrgsEnrollmentsPerCourseRetrieve(org: string, active?: 'y' | 'yes' | 'true' | 'True' | 'n' | 'no' | 'false' | 'False', departmentId?: number, endDate?: string, format?: 'json', includeMainPlatform?: boolean, length?: number, page?: number, startDate?: string): CancelablePromise<Enrollments>;
+    /**
+     * List all learners on the platform with aggregated metrics.
+     *
+     * This endpoint returns a paginated list of all learners with key metrics including:
+     * - Enrollment counts
+     * - Completion counts
+     * - Time spent on platform
+     *
+     * Query Parameters:
+     * page (int): Page number for pagination
+     * length (int): Number of items per page
+     * search (str): Filter learners by username, email, or name
+     *
+     * Returns:
+     * A paginated list of learners with their associated metrics.
+     * @param org
+     * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
+     * @param format Format
+     *
+     * * `json` - json
+     * @param includeMainPlatform Include main platform data
+     * @param length Size of data to return
+     * @param page Page offset
+     * @param search Search string for learner
+     * @returns PerlearnerUserList
+     * @throws ApiError
+     */
+    static audienceOrgsRegisteredUsersRetrieve(org: string, departmentId?: number, format?: 'json', includeMainPlatform?: boolean, length?: number, page?: number, search?: string): CancelablePromise<PerlearnerUserList>;
+    /**
+     * Get registered user counts over time.
+     *
+     * This endpoint provides daily counts of new user registrations over a
+     * specified time period.
+     *
+     * 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)
+     *
+     * Returns:
+     * Daily registration counts over the specified time period, with change metrics
+     * compared to previous periods.
+     *
+     * Default time range is the last 7 days if no dates are specified.
+     * @param org
+     * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
+     * @param endDate end date. ISO 8601
+     * @param format Format
+     *
+     * * `json` - json
+     * @param includeMainPlatform Include main platform data
+     * @param startDate start date. ISO 8601
+     * @returns OvertimeWithChangeInfo
+     * @throws ApiError
+     */
+    static audienceOrgsRegisteredUsersOverTimeRetrieve(org: string, departmentId?: number, endDate?: string, format?: 'json', includeMainPlatform?: boolean, startDate?: string): CancelablePromise<OvertimeWithChangeInfo>;
+    /**
+     * 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.
+     * @param org
+     * @param active 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
+     * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
+     * @param endDate end date. ISO 8601
+     * @param format Format
+     *
+     * * `json` - json
+     * @param includeMainPlatform Include main platform data
+     * @param length Size of data to return
+     * @param page Page offset
+     * @param startDate start date. ISO 8601
+     * @returns Enrollments
+     * @throws ApiError
+     */
+    static audienceOrgsRegisteredUsersPerCourseRetrieve(org: string, active?: 'y' | 'yes' | 'true' | 'True' | 'n' | 'no' | 'false' | 'False', departmentId?: number, endDate?: string, format?: 'json', includeMainPlatform?: boolean, length?: number, page?: number, startDate?: string): CancelablePromise<Enrollments>;
+}