@iblai/iblai-api 4.23.2-test-core → 4.24.0-core

package/src/models/UserInfo.ts

@@ -2,17 +2,14 @@
 /* istanbul ignore file */
 /* tslint:disable */
 /* eslint-disable */
+/**
+ * Serializer for user information.
+ */
 export type UserInfo = {
-    /**
-     * edX user ID
-     */
-    id: number;
-    /**
-     * edX username
-     */
-    username?: string | null;
-    email: string;
-    active: boolean;
-    edx_data: any;
+    user_id: number;
+    username: string | null;
+    email: string | null;
+    name: string;
+    is_active: boolean;
 };
 

package/src/services/AiAnalyticsService.ts

@@ -18,6 +18,7 @@ import type { EngagementPerCourse } from '../models/EngagementPerCourse';
 import type { Enrollments } from '../models/Enrollments';
 import type { EnrollmentsPerUser } from '../models/EnrollmentsPerUser';
 import type { GradingPerUser } from '../models/GradingPerUser';
+import type { LearnerAnalyticsResponse } from '../models/LearnerAnalyticsResponse';
 import type { LearnerInformationAPI } from '../models/LearnerInformationAPI';
 import type { NewPerLearnerList } from '../models/NewPerLearnerList';
 import type { OvertimeWithChangeInfo } from '../models/OvertimeWithChangeInfo';
@@ -49,6 +50,59 @@ import type { CancelablePromise } from '../core/CancelablePromise';
 import { OpenAPI } from '../core/OpenAPI';
 import { request as __request } from '../core/request';
 export class AiAnalyticsService {
+    /**
+     * Unified API endpoint for learner analytics.
+     *
+     * This endpoint provides either:
+     * 1. Cross-platform summary (when only username is provided)
+     * 2. Platform-specific detailed data (when username + platform_key are provided)
+     *
+     * Query params:
+     * - username (required): Username of the learner
+     * - platform_key (optional): Platform key for platform-specific data
+     * - page (optional): Page number (default: 1)
+     * - limit (optional): Records per page (default: 20, max: 100)
+     *
+     * Returns:
+     * - If platform_key provided: Detailed platform metrics
+     * - If no platform_key: Cross-platform summary with pagination
+     * @returns LearnerAnalyticsResponse
+     * @throws ApiError
+     */
+    public static analyticsLearnersRetrieve({
+        limit = 20,
+        page = 1,
+        platformKey,
+        username,
+    }: {
+        /**
+         * Number of records per page (default: 20, max: 100)
+         */
+        limit?: number,
+        /**
+         * Page number (default: 1)
+         */
+        page?: number,
+        /**
+         * Optional platform key - if provided, returns platform-specific detailed data
+         */
+        platformKey?: string,
+        /**
+         * Username of the learner to get analytics for. Defaults to self if not provided.
+         */
+        username?: string,
+    }): CancelablePromise<LearnerAnalyticsResponse> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/api/analytics/learners/',
+            query: {
+                'limit': limit,
+                'page': page,
+                'platform_key': platformKey,
+                'username': username,
+            },
+        });
+    }
     /**
      * Update time spent tracking data from client-side events.
      *