@iblai/iblai-api 4.44.1-core → 4.45.1-core

package/src/services/AiAnalyticsService.ts

@@ -8,6 +8,7 @@ import type { ActivityAPI } from '../models/ActivityAPI';
 import type { Average } from '../models/Average';
 import type { AverageOvertime } from '../models/AverageOvertime';
 import type { AvgCourseGradeWithCutoff } from '../models/AvgCourseGradeWithCutoff';
+import type { ContentResponse } from '../models/ContentResponse';
 import type { Count } from '../models/Count';
 import type { CourseCompletionPerCourse } from '../models/CourseCompletionPerCourse';
 import type { CourseCompletionSummaryOvertime } from '../models/CourseCompletionSummaryOvertime';
@@ -51,6 +52,75 @@ import type { CancelablePromise } from '../core/CancelablePromise';
 import { OpenAPI } from '../core/OpenAPI';
 import { request as __request } from '../core/request';
 export class AiAnalyticsService {
+    /**
+     * Get Content Analytics
+     *
+     * Retrieve aggregated analytics for catalog content (courses, programs, pathways, skills).
+     *
+     * Returns both summary statistics and paginated list of content items with individual analytics.
+     * When a platform_key is provided, results are filtered to show only content consumed by
+     * learners associated with that platform.
+     *
+     * **Metrics supported:**
+     * - `course` or `courses`: Course analytics
+     * - `program` or `programs`: Program analytics
+     * - `pathway` or `pathways`: Pathway analytics
+     * - `skill` or `skills`: Skill analytics
+     *
+     * **Platform Filtering:**
+     * - Without platform_key: Shows global analytics across all platforms
+     * - With platform_key: Shows analytics filtered by platform learners only
+     *
+     * **External Content:**
+     * - Content not owned by the requesting platform but used by its learners is marked as "external"
+     * - External content has limited metadata exposure for privacy
+     *
+     * @returns ContentResponse
+     * @throws ApiError
+     */
+    public static getContentAnalytics({
+        metric,
+        limit = 20,
+        page = 1,
+        platformKey,
+    }: {
+        /**
+         * The type of content to retrieve (course, program, pathway, skill)
+         *
+         * * `course` - course
+         * * `courses` - courses
+         * * `program` - program
+         * * `programs` - programs
+         * * `pathway` - pathway
+         * * `pathways` - pathways
+         * * `skill` - skill
+         * * `skills` - skills
+         */
+        metric: 'course' | 'courses' | 'program' | 'programs' | 'pathway' | 'pathways' | 'skill' | 'skills',
+        /**
+         * Number of items per page (max 100)
+         */
+        limit?: number,
+        /**
+         * Page number for pagination
+         */
+        page?: number,
+        /**
+         * Optional platform key to filter results by platform
+         */
+        platformKey?: string | null,
+    }): CancelablePromise<ContentResponse> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/api/analytics/content/',
+            query: {
+                'limit': limit,
+                'metric': metric,
+                'page': page,
+                'platform_key': platformKey,
+            },
+        });
+    }
     /**
      *
      * Retrieve a holistic snapshot of a learner across catalog enrollments, mentor

package/src/services/AnalyticsService.ts

@@ -0,0 +1,133 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+import type { ContentResponse } from '../models/ContentResponse';
+import type { LearnerAnalyticsResponse } from '../models/LearnerAnalyticsResponse';
+import type { CancelablePromise } from '../core/CancelablePromise';
+import { OpenAPI } from '../core/OpenAPI';
+import { request as __request } from '../core/request';
+export class AnalyticsService {
+    /**
+     * Get Content Analytics
+     *
+     * Retrieve aggregated analytics for catalog content (courses, programs, pathways, skills).
+     *
+     * Returns both summary statistics and paginated list of content items with individual analytics.
+     * When a platform_key is provided, results are filtered to show only content consumed by
+     * learners associated with that platform.
+     *
+     * **Metrics supported:**
+     * - `course` or `courses`: Course analytics
+     * - `program` or `programs`: Program analytics
+     * - `pathway` or `pathways`: Pathway analytics
+     * - `skill` or `skills`: Skill analytics
+     *
+     * **Platform Filtering:**
+     * - Without platform_key: Shows global analytics across all platforms
+     * - With platform_key: Shows analytics filtered by platform learners only
+     *
+     * **External Content:**
+     * - Content not owned by the requesting platform but used by its learners is marked as "external"
+     * - External content has limited metadata exposure for privacy
+     *
+     * @returns ContentResponse
+     * @throws ApiError
+     */
+    public static getContentAnalytics({
+        metric,
+        limit = 20,
+        page = 1,
+        platformKey,
+    }: {
+        /**
+         * The type of content to retrieve (course, program, pathway, skill)
+         *
+         * * `course` - course
+         * * `courses` - courses
+         * * `program` - program
+         * * `programs` - programs
+         * * `pathway` - pathway
+         * * `pathways` - pathways
+         * * `skill` - skill
+         * * `skills` - skills
+         */
+        metric: 'course' | 'courses' | 'program' | 'programs' | 'pathway' | 'pathways' | 'skill' | 'skills',
+        /**
+         * Number of items per page (max 100)
+         */
+        limit?: number,
+        /**
+         * Page number for pagination
+         */
+        page?: number,
+        /**
+         * Optional platform key to filter results by platform
+         */
+        platformKey?: string | null,
+    }): CancelablePromise<ContentResponse> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/api/analytics/content/',
+            query: {
+                'limit': limit,
+                'metric': metric,
+                'page': page,
+                'platform_key': platformKey,
+            },
+        });
+    }
+    /**
+     * 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,
+            },
+        });
+    }
+}