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

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

@@ -14,6 +14,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';
@@ -43,6 +44,43 @@ import type { WatchedVideosPerCourse } from '../models/WatchedVideosPerCourse';
 import type { WatchedVideosPerUser } from '../models/WatchedVideosPerUser';
 import type { CancelablePromise } from '../core/CancelablePromise';
 export declare 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
+     */
+    static analyticsLearnersRetrieve({ limit, page, 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>;
     /**
      * Update time spent tracking data from client-side events.
      *

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@iblai/iblai-api",
-  "version": "4.23.2-test-core",
+  "version": "4.24.0-core",
   "main": "dist/index.cjs.js",
   "module": "dist/index.esm.js",
   "type": "module",

package/sdk_schema.yml

@@ -1,9 +1,69 @@
 openapi: 3.0.3
 info:
   title: ibl-data-manager
-  version: 4.23.2-core
+  version: 4.24.0-core
   description: API for iblai
 paths:
+  /api/analytics/learners/:
+    get:
+      operationId: analytics_learners_retrieve
+      description: |-
+        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
+      parameters:
+      - in: query
+        name: limit
+        schema:
+          type: integer
+          maximum: 100
+          minimum: 1
+          default: 20
+        description: 'Number of records per page (default: 20, max: 100)'
+      - in: query
+        name: page
+        schema:
+          type: integer
+          minimum: 1
+          default: 1
+        description: 'Page number (default: 1)'
+      - in: query
+        name: platform_key
+        schema:
+          type: string
+          minLength: 1
+        description: Optional platform key - if provided, returns platform-specific
+          detailed data
+      - in: query
+        name: username
+        schema:
+          type: string
+          minLength: 1
+        description: Username of the learner to get analytics for. Defaults to self
+          if not provided.
+      tags:
+      - ai-analytics
+      security:
+      - PlatformApiKeyAuthentication: []
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/LearnerAnalyticsResponse'
+          description: ''
   /api/analytics/orgs/{org}/time/update/:
     post:
       operationId: analytics_orgs_time_update_create
@@ -27658,6 +27718,21 @@ components:
       - last_access_date
       - name
       - time_invested
+    ActivityInfo:
+      type: object
+      description: Serializer for activity information.
+      properties:
+        first_activity:
+          type: string
+          format: date-time
+          nullable: true
+        last_activity:
+          type: string
+          format: date-time
+          nullable: true
+      required:
+      - first_activity
+      - last_activity
     App:
       type: object
       properties:
@@ -30455,6 +30530,53 @@ components:
       required:
       - key
       - user_id
+    LearnerAnalyticsResponse:
+      type: object
+      description: Unified response serializer for learner analytics endpoint.
+      properties:
+        user:
+          $ref: '#/components/schemas/UserInfo'
+        results:
+          type: array
+          items:
+            $ref: '#/components/schemas/LearnerAnalyticsResult'
+        pagination:
+          $ref: '#/components/schemas/Pagination'
+        generated_at:
+          type: string
+          format: date-time
+      required:
+      - generated_at
+      - pagination
+      - results
+      - user
+    LearnerAnalyticsResult:
+      type: object
+      description: Unified serializer for learner analytics results - handles both
+        cross-platform and platform-specific data.
+      properties:
+        platform_id:
+          type: integer
+        platform_name:
+          type: string
+        platform_key:
+          type: string
+          nullable: true
+        summary:
+          $ref: '#/components/schemas/PlatformSummary'
+        metrics:
+          $ref: '#/components/schemas/PlatformMetrics'
+        activity:
+          $ref: '#/components/schemas/ActivityInfo'
+        last_updated:
+          type: string
+          format: date-time
+        user_id:
+          type: integer
+      required:
+      - platform_id
+      - platform_key
+      - platform_name
     LearnerInformationAPI:
       type: object
       properties:
@@ -30829,6 +30951,19 @@ components:
         * `document` - Document
         * `audio` - Audio
         * `other` - Other
+    MetricDetail:
+      type: object
+      description: Base serializer for detailed metric data.
+      properties:
+        total:
+          type: integer
+        details:
+          type: array
+          items:
+            type: object
+            additionalProperties: {}
+      required:
+      - total
     ModeEnum:
       enum:
       - subscription
@@ -31853,24 +31988,35 @@ components:
       - results
     Pagination:
       type: object
+      description: Serializer for pagination metadata.
       properties:
-        totalItems:
+        page:
           type: integer
-          description: Total records
-        currentPage:
+        limit:
           type: integer
-          description: Current Page
-        perPage:
+        total_pages:
+          type: integer
+        total_records:
+          type: integer
+        has_next:
+          type: boolean
+        has_previous:
+          type: boolean
+        next_page:
           type: integer
-          description: Size of data returned per page
-        totalPages:
+          nullable: true
+        previous_page:
           type: integer
-          description: Amount of pages
+          nullable: true
       required:
-      - currentPage
-      - perPage
-      - totalItems
-      - totalPages
+      - has_next
+      - has_previous
+      - limit
+      - next_page
+      - page
+      - previous_page
+      - total_pages
+      - total_records
     PatchedMediaResource:
       type: object
       properties:
@@ -33423,6 +33569,32 @@ components:
         * `4` - STOPPING
         * `5` - STOPPED
         * `6` - REPAIR
+    PlatformMetrics:
+      type: object
+      description: Serializer for detailed platform metrics (platform-specific view).
+      properties:
+        enrollments:
+          $ref: '#/components/schemas/MetricDetail'
+        programs:
+          $ref: '#/components/schemas/MetricDetail'
+        pathways:
+          $ref: '#/components/schemas/MetricDetail'
+        resources:
+          $ref: '#/components/schemas/MetricDetail'
+        skills:
+          $ref: '#/components/schemas/SkillsMetric'
+        credentials:
+          $ref: '#/components/schemas/MetricDetail'
+        points:
+          $ref: '#/components/schemas/PointsMetric'
+      required:
+      - credentials
+      - enrollments
+      - pathways
+      - points
+      - programs
+      - resources
+      - skills
     PlatformPublicMetadata:
       type: object
       properties:
@@ -33548,6 +33720,52 @@ components:
       - next_page
       - previous_page
       - results
+    PlatformSummary:
+      type: object
+      description: Serializer for platform summary data (cross-platform view).
+      properties:
+        enrollments:
+          type: integer
+        programs:
+          type: integer
+        pathways:
+          type: integer
+        resources:
+          type: integer
+        reported_skills:
+          type: integer
+        desired_skills:
+          type: integer
+        assigned_skills:
+          type: integer
+        total_skills:
+          type: integer
+        credentials:
+          type: integer
+        points:
+          type: number
+          format: double
+        first_activity:
+          type: string
+          format: date-time
+          nullable: true
+        last_activity:
+          type: string
+          format: date-time
+          nullable: true
+      required:
+      - assigned_skills
+      - credentials
+      - desired_skills
+      - enrollments
+      - first_activity
+      - last_activity
+      - pathways
+      - points
+      - programs
+      - reported_skills
+      - resources
+      - total_skills
     PlatformUpdatePostRequest:
       type: object
       properties:
@@ -33568,6 +33786,20 @@ components:
       required:
       - key
       - user_id
+    PointsMetric:
+      type: object
+      description: Serializer for points metrics.
+      properties:
+        total:
+          type: number
+          format: double
+        details:
+          type: array
+          items:
+            type: object
+            additionalProperties: {}
+      required:
+      - total
     PointsPercentile:
       type: object
       properties:
@@ -35859,6 +36091,28 @@ components:
       - name
       - platform
       - threshold
+    SkillsMetric:
+      type: object
+      description: Serializer for skills metrics with breakdown.
+      properties:
+        reported:
+          type: integer
+        desired:
+          type: integer
+        assigned:
+          type: integer
+        total:
+          type: integer
+        details:
+          type: array
+          items:
+            type: object
+            additionalProperties: {}
+      required:
+      - assigned
+      - desired
+      - reported
+      - total
     StateEnum:
       enum:
       - pending
@@ -36607,26 +36861,27 @@ components:
       - message
     UserInfo:
       type: object
+      description: Serializer for user information.
       properties:
-        id:
+        user_id:
           type: integer
-          description: edX user ID
         username:
           type: string
           nullable: true
-          description: edX username
-          maxLength: 100
         email:
           type: string
           format: email
-        active:
+          nullable: true
+        name:
+          type: string
+        is_active:
           type: boolean
-        edx_data: {}
       required:
-      - active
-      - edx_data
       - email
-      - id
+      - is_active
+      - name
+      - user_id
+      - username
     UserLicenseAssignmentCreate:
       type: object
       description: Request serializer for UserLicenseAssignmentView POST endpoint

package/src/core/OpenAPI.ts

@@ -21,7 +21,7 @@ export type OpenAPIConfig = {
 
 export const OpenAPI: OpenAPIConfig = {
     BASE: 'https://base.manager.iblai.app',
-    VERSION: '4.23.2-core',
+    VERSION: '4.24.0-core',
     WITH_CREDENTIALS: false,
     CREDENTIALS: 'include',
     TOKEN: undefined,

package/src/index.ts

@@ -15,6 +15,7 @@ export type { ActiveUsersPerCourse } from './models/ActiveUsersPerCourse';
 export type { ActiveUsersPerCourseData } from './models/ActiveUsersPerCourseData';
 export type { ActivityAPI } from './models/ActivityAPI';
 export type { ActivityData } from './models/ActivityData';
+export type { ActivityInfo } from './models/ActivityInfo';
 export type { App } from './models/App';
 export type { AppleSubscriptionStatusRequest } from './models/AppleSubscriptionStatusRequest';
 export type { AppleSubscriptionStatusView } from './models/AppleSubscriptionStatusView';
@@ -133,6 +134,8 @@ export type { Issuer } from './models/Issuer';
 export type { IssuerAuthority } from './models/IssuerAuthority';
 export { ItemTypeEnum } from './models/ItemTypeEnum';
 export type { LauncherViewPostRequest } from './models/LauncherViewPostRequest';
+export type { LearnerAnalyticsResponse } from './models/LearnerAnalyticsResponse';
+export type { LearnerAnalyticsResult } from './models/LearnerAnalyticsResult';
 export type { LearnerInformationAPI } from './models/LearnerInformationAPI';
 export type { LearnerInformationAPIData } from './models/LearnerInformationAPIData';
 export type { LtiKey } from './models/LtiKey';
@@ -145,6 +148,7 @@ export type { MarkAllReadRequest } from './models/MarkAllReadRequest';
 export type { MarkAllReadResponse } from './models/MarkAllReadResponse';
 export type { MediaResource } from './models/MediaResource';
 export { MediaTypeEnum } from './models/MediaTypeEnum';
+export type { MetricDetail } from './models/MetricDetail';
 export { ModeEnum } from './models/ModeEnum';
 export type { NewPerLearnerList } from './models/NewPerLearnerList';
 export type { NewPerLearnerListData } from './models/NewPerLearnerListData';
@@ -238,13 +242,16 @@ export type { PlatformLicenseDetail } from './models/PlatformLicenseDetail';
 export type { PlatformLicenseUpdate } from './models/PlatformLicenseUpdate';
 export type { PlatformList } from './models/PlatformList';
 export { PlatformListStatusEnum } from './models/PlatformListStatusEnum';
+export type { PlatformMetrics } from './models/PlatformMetrics';
 export type { PlatformPublicMetadata } from './models/PlatformPublicMetadata';
 export type { PlatformSkillPointBulkRequest } from './models/PlatformSkillPointBulkRequest';
 export type { PlatformSkillPointBulkResponse } from './models/PlatformSkillPointBulkResponse';
 export type { PlatformSkillPointGroupRequest } from './models/PlatformSkillPointGroupRequest';
 export type { PlatformSkillPointRequest } from './models/PlatformSkillPointRequest';
 export type { PlatformSkillPointResponse } from './models/PlatformSkillPointResponse';
+export type { PlatformSummary } from './models/PlatformSummary';
 export type { PlatformUpdatePostRequest } from './models/PlatformUpdatePostRequest';
+export type { PointsMetric } from './models/PointsMetric';
 export type { PointsPercentile } from './models/PointsPercentile';
 export type { PreviewResponse } from './models/PreviewResponse';
 export type { Program } from './models/Program';
@@ -313,6 +320,7 @@ export type { Skill } from './models/Skill';
 export type { SkillCreateUpdateRequest } from './models/SkillCreateUpdateRequest';
 export type { SkillDetail } from './models/SkillDetail';
 export type { SkillInfo } from './models/SkillInfo';
+export type { SkillsMetric } from './models/SkillsMetric';
 export type { SkillThreshold } from './models/SkillThreshold';
 export { StateEnum } from './models/StateEnum';
 export type { StripeBillingPageIdentifierResponse } from './models/StripeBillingPageIdentifierResponse';

package/src/models/ActivityInfo.ts

@@ -0,0 +1,12 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Serializer for activity information.
+ */
+export type ActivityInfo = {
+    first_activity: string | null;
+    last_activity: string | null;
+};
+

package/src/models/LearnerAnalyticsResponse.ts

@@ -0,0 +1,17 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+import type { LearnerAnalyticsResult } from './LearnerAnalyticsResult';
+import type { Pagination } from './Pagination';
+import type { UserInfo } from './UserInfo';
+/**
+ * Unified response serializer for learner analytics endpoint.
+ */
+export type LearnerAnalyticsResponse = {
+    user: UserInfo;
+    results: Array<LearnerAnalyticsResult>;
+    pagination: Pagination;
+    generated_at: string;
+};
+

package/src/models/LearnerAnalyticsResult.ts

@@ -0,0 +1,21 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+import type { ActivityInfo } from './ActivityInfo';
+import type { PlatformMetrics } from './PlatformMetrics';
+import type { PlatformSummary } from './PlatformSummary';
+/**
+ * Unified serializer for learner analytics results - handles both cross-platform and platform-specific data.
+ */
+export type LearnerAnalyticsResult = {
+    platform_id: number;
+    platform_name: string;
+    platform_key: string | null;
+    summary?: PlatformSummary;
+    metrics?: PlatformMetrics;
+    activity?: ActivityInfo;
+    last_updated?: string;
+    user_id?: number;
+};
+

package/src/models/MetricDetail.ts

@@ -0,0 +1,12 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Base serializer for detailed metric data.
+ */
+export type MetricDetail = {
+    total: number;
+    details?: Array<Record<string, any>>;
+};
+

package/src/models/Pagination.ts

@@ -2,22 +2,17 @@
 /* istanbul ignore file */
 /* tslint:disable */
 /* eslint-disable */
+/**
+ * Serializer for pagination metadata.
+ */
 export type Pagination = {
-    /**
-     * Total records
-     */
-    totalItems: number;
-    /**
-     * Current Page
-     */
-    currentPage: number;
-    /**
-     * Size of data returned per page
-     */
-    perPage: number;
-    /**
-     * Amount of pages
-     */
-    totalPages: number;
+    page: number;
+    limit: number;
+    total_pages: number;
+    total_records: number;
+    has_next: boolean;
+    has_previous: boolean;
+    next_page: number | null;
+    previous_page: number | null;
 };
 

package/src/models/PlatformMetrics.ts

@@ -0,0 +1,20 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+import type { MetricDetail } from './MetricDetail';
+import type { PointsMetric } from './PointsMetric';
+import type { SkillsMetric } from './SkillsMetric';
+/**
+ * Serializer for detailed platform metrics (platform-specific view).
+ */
+export type PlatformMetrics = {
+    enrollments: MetricDetail;
+    programs: MetricDetail;
+    pathways: MetricDetail;
+    resources: MetricDetail;
+    skills: SkillsMetric;
+    credentials: MetricDetail;
+    points: PointsMetric;
+};
+

package/src/models/PlatformSummary.ts

@@ -0,0 +1,22 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Serializer for platform summary data (cross-platform view).
+ */
+export type PlatformSummary = {
+    enrollments: number;
+    programs: number;
+    pathways: number;
+    resources: number;
+    reported_skills: number;
+    desired_skills: number;
+    assigned_skills: number;
+    total_skills: number;
+    credentials: number;
+    points: number;
+    first_activity: string | null;
+    last_activity: string | null;
+};
+

package/src/models/PointsMetric.ts

@@ -0,0 +1,12 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Serializer for points metrics.
+ */
+export type PointsMetric = {
+    total: number;
+    details?: Array<Record<string, any>>;
+};
+

package/src/models/SkillsMetric.ts

@@ -0,0 +1,15 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Serializer for skills metrics with breakdown.
+ */
+export type SkillsMetric = {
+    reported: number;
+    desired: number;
+    assigned: number;
+    total: number;
+    details?: Array<Record<string, any>>;
+};
+