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

package/sdk_schema.yml

@@ -1,9 +1,105 @@
 openapi: 3.0.3
 info:
   title: ibl-data-manager
-  version: 4.44.0-core
+  version: 4.45.1-core
   description: API for iblai
 paths:
+  /api/analytics/content/:
+    get:
+      operationId: get_content_analytics
+      description: "\n        Retrieve aggregated analytics for catalog content (courses,\
+        \ programs, pathways, skills).\n        \n        Returns both summary statistics\
+        \ and paginated list of content items with individual analytics.\n       \
+        \ When a platform_key is provided, results are filtered to show only content\
+        \ consumed by \n        learners associated with that platform.\n        \n\
+        \        **Metrics supported:**\n        - `course` or `courses`: Course analytics\n\
+        \        - `program` or `programs`: Program analytics  \n        - `pathway`\
+        \ or `pathways`: Pathway analytics\n        - `skill` or `skills`: Skill analytics\n\
+        \        \n        **Platform Filtering:**\n        - Without platform_key:\
+        \ Shows global analytics across all platforms\n        - With platform_key:\
+        \ Shows analytics filtered by platform learners only\n        \n        **External\
+        \ Content:**\n        - Content not owned by the requesting platform but used\
+        \ by its learners is marked as \"external\"\n        - External content has\
+        \ limited metadata exposure for privacy\n        "
+      summary: Get Content Analytics
+      parameters:
+      - in: query
+        name: limit
+        schema:
+          type: integer
+          maximum: 100
+          minimum: 1
+          default: 20
+        description: Number of items per page (max 100)
+      - in: query
+        name: metric
+        schema:
+          enum:
+          - course
+          - courses
+          - program
+          - programs
+          - pathway
+          - pathways
+          - skill
+          - skills
+          type: string
+          minLength: 1
+        description: |-
+          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
+        required: true
+      - in: query
+        name: page
+        schema:
+          type: integer
+          minimum: 1
+          default: 1
+        description: Page number for pagination
+      - in: query
+        name: platform_key
+        schema:
+          type: string
+          nullable: true
+        description: Optional platform key to filter results by platform
+      tags:
+      - ai-analytics
+      - analytics
+      security:
+      - PlatformApiKeyAuthentication: []
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ContentResponse'
+          description: ''
+        '400':
+          content:
+            application/json:
+              schema:
+                description: Invalid metric or parameters
+          description: ''
+        '404':
+          content:
+            application/json:
+              schema:
+                description: Page out of range
+          description: ''
+        '500':
+          content:
+            application/json:
+              schema:
+                description: Internal server error
+          description: ''
   /api/analytics/learner/details:
     get:
       operationId: analytics_learner_details_retrieve
@@ -143,6 +239,7 @@ paths:
           if not provided.
       tags:
       - ai-analytics
+      - analytics
       security:
       - PlatformApiKeyAuthentication: []
       responses:
@@ -30809,6 +30906,247 @@ components:
       required:
       - key
       - value
+    ContentAnalytics:
+      type: object
+      description: Serializer for individual content item analytics.
+      properties:
+        enrollments:
+          type: integer
+          description: Total enrollments for this item
+        active_enrollments:
+          type: integer
+          description: Active enrollments for this item
+        completion_rate:
+          type: number
+          format: double
+          description: Completion rate percentage
+        avg_rating:
+          type: number
+          format: double
+          nullable: true
+          description: Average rating
+        rating_count:
+          type: integer
+          description: Number of ratings
+        associated_courses:
+          type: integer
+          description: Associated courses (for skills)
+        learners_count:
+          type: integer
+          description: Number of learners (for skills)
+      required:
+      - active_enrollments
+      - completion_rate
+      - enrollments
+    ContentAverages:
+      type: object
+      description: Serializer for content summary averages.
+      properties:
+        completion_rate:
+          type: number
+          format: double
+          description: Average completion rate percentage
+        average_rating:
+          type: number
+          format: double
+          description: Average rating
+        enrollments_per_course:
+          type: number
+          format: double
+          description: Average enrollments per course
+        enrollments_per_program:
+          type: number
+          format: double
+          description: Average enrollments per program
+        enrollments_per_pathway:
+          type: number
+          format: double
+          description: Average enrollments per pathway
+        courses_per_skill:
+          type: number
+          format: double
+          description: Average courses per skill
+    ContentItem:
+      type: object
+      description: Serializer for individual content items.
+      properties:
+        id:
+          type: string
+          description: Content identifier
+        name:
+          type: string
+          description: Content name
+        slug:
+          type: string
+          description: Content slug
+        platform:
+          type: string
+          nullable: true
+          description: Platform key
+        external:
+          type: boolean
+          description: Whether content is external to the platform
+        analytics:
+          $ref: '#/components/schemas/ContentAnalytics'
+        instructor:
+          type: string
+          nullable: true
+          description: Instructor name
+        category:
+          type: string
+          nullable: true
+          description: Content category
+        duration:
+          type: string
+          nullable: true
+          description: Content duration
+        enabled:
+          type: boolean
+          description: Whether content is enabled
+        created:
+          type: string
+          nullable: true
+          description: Creation date
+        updated:
+          type: string
+          nullable: true
+          description: Last update date
+        metadata: {}
+      required:
+      - analytics
+      - external
+      - id
+      - name
+      - platform
+      - slug
+    ContentPagination:
+      type: object
+      description: Serializer for content pagination metadata.
+      properties:
+        count:
+          type: integer
+          description: Total number of items
+        next:
+          type: string
+          nullable: true
+          description: URL for next page
+        previous:
+          type: string
+          nullable: true
+          description: URL for previous page
+        current_page:
+          type: integer
+          description: Current page number
+        total_pages:
+          type: integer
+          description: Total number of pages
+      required:
+      - count
+      - current_page
+      - total_pages
+    ContentResponse:
+      type: object
+      description: Serializer for the complete content API response.
+      properties:
+        metric:
+          type: string
+          description: The metric type (course, program, pathway, skill)
+        summary:
+          allOf:
+          - $ref: '#/components/schemas/ContentSummary'
+          description: Summary statistics for the metric
+        pagination:
+          allOf:
+          - $ref: '#/components/schemas/ContentPagination'
+          description: Pagination metadata
+        results:
+          type: array
+          items:
+            $ref: '#/components/schemas/ContentItem'
+          description: List of content items
+      required:
+      - metric
+      - pagination
+      - results
+      - summary
+    ContentSummary:
+      type: object
+      description: Serializer for content summary data.
+      properties:
+        totals:
+          $ref: '#/components/schemas/ContentTotals'
+        averages:
+          $ref: '#/components/schemas/ContentAverages'
+      required:
+      - averages
+      - totals
+    ContentTotals:
+      type: object
+      description: Serializer for content summary totals.
+      properties:
+        total_learners:
+          type: integer
+          description: Total number of learners
+        total_enrollments:
+          type: integer
+          description: Total number of enrollments
+        courses:
+          type: integer
+          description: Total number of courses
+        active_courses:
+          type: integer
+          description: Number of active courses
+        platform_courses:
+          type: integer
+          description: Number of platform-owned courses
+        external_courses:
+          type: integer
+          description: Number of external courses
+        programs:
+          type: integer
+          description: Total number of programs
+        active_programs:
+          type: integer
+          description: Number of active programs
+        platform_programs:
+          type: integer
+          description: Number of platform-owned programs
+        external_programs:
+          type: integer
+          description: Number of external programs
+        pathways:
+          type: integer
+          description: Total number of pathways
+        active_pathways:
+          type: integer
+          description: Number of active pathways
+        platform_pathways:
+          type: integer
+          description: Number of platform-owned pathways
+        external_pathways:
+          type: integer
+          description: Number of external pathways
+        skills:
+          type: integer
+          description: Total number of skills
+        active_skills:
+          type: integer
+          description: Number of active skills
+        platform_skills:
+          type: integer
+          description: Number of platform-owned skills
+        external_skills:
+          type: integer
+          description: Number of external skills
+        associated_courses:
+          type: integer
+          description: Number of courses associated with skills
+        learners_with_skills:
+          type: integer
+          description: Number of learners with skills
+      required:
+      - total_enrollments
+      - total_learners
     ContextResponse:
       type: object
       description: Response serializer for context 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.44.0-core',
+    VERSION: '4.45.1-core',
     WITH_CREDENTIALS: false,
     CREDENTIALS: 'include',
     TOKEN: undefined,

package/src/index.ts

@@ -55,6 +55,13 @@ export { CeleryHeartbeatFailStatusEnum } from './models/CeleryHeartbeatFailStatu
 export { CeleryHeartbeatStatusEnum } from './models/CeleryHeartbeatStatusEnum';
 export type { Company } from './models/Company';
 export type { ConfigurationItem } from './models/ConfigurationItem';
+export type { ContentAnalytics } from './models/ContentAnalytics';
+export type { ContentAverages } from './models/ContentAverages';
+export type { ContentItem } from './models/ContentItem';
+export type { ContentPagination } from './models/ContentPagination';
+export type { ContentResponse } from './models/ContentResponse';
+export type { ContentSummary } from './models/ContentSummary';
+export type { ContentTotals } from './models/ContentTotals';
 export type { ContextResponse } from './models/ContextResponse';
 export type { Count } from './models/Count';
 export type { CountData } from './models/CountData';
@@ -446,6 +453,7 @@ export type { WatchedVideosPerUserData } from './models/WatchedVideosPerUserData
 export type { WhitelistedDomain } from './models/WhitelistedDomain';
 
 export { AiAnalyticsService } from './services/AiAnalyticsService';
+export { AnalyticsService } from './services/AnalyticsService';
 export { CareerService } from './services/CareerService';
 export { CatalogService } from './services/CatalogService';
 export { CommerceService } from './services/CommerceService';

package/src/models/ContentAnalytics.ts

@@ -0,0 +1,38 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Serializer for individual content item analytics.
+ */
+export type ContentAnalytics = {
+    /**
+     * Total enrollments for this item
+     */
+    enrollments: number;
+    /**
+     * Active enrollments for this item
+     */
+    active_enrollments: number;
+    /**
+     * Completion rate percentage
+     */
+    completion_rate: number;
+    /**
+     * Average rating
+     */
+    avg_rating?: number | null;
+    /**
+     * Number of ratings
+     */
+    rating_count?: number;
+    /**
+     * Associated courses (for skills)
+     */
+    associated_courses?: number;
+    /**
+     * Number of learners (for skills)
+     */
+    learners_count?: number;
+};
+

package/src/models/ContentAverages.ts

@@ -0,0 +1,34 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Serializer for content summary averages.
+ */
+export type ContentAverages = {
+    /**
+     * Average completion rate percentage
+     */
+    completion_rate?: number;
+    /**
+     * Average rating
+     */
+    average_rating?: number;
+    /**
+     * Average enrollments per course
+     */
+    enrollments_per_course?: number;
+    /**
+     * Average enrollments per program
+     */
+    enrollments_per_program?: number;
+    /**
+     * Average enrollments per pathway
+     */
+    enrollments_per_pathway?: number;
+    /**
+     * Average courses per skill
+     */
+    courses_per_skill?: number;
+};
+

package/src/models/ContentItem.ts

@@ -0,0 +1,57 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+import type { ContentAnalytics } from './ContentAnalytics';
+/**
+ * Serializer for individual content items.
+ */
+export type ContentItem = {
+    /**
+     * Content identifier
+     */
+    id: string;
+    /**
+     * Content name
+     */
+    name: string;
+    /**
+     * Content slug
+     */
+    slug: string;
+    /**
+     * Platform key
+     */
+    platform: string | null;
+    /**
+     * Whether content is external to the platform
+     */
+    external: boolean;
+    analytics: ContentAnalytics;
+    /**
+     * Instructor name
+     */
+    instructor?: string | null;
+    /**
+     * Content category
+     */
+    category?: string | null;
+    /**
+     * Content duration
+     */
+    duration?: string | null;
+    /**
+     * Whether content is enabled
+     */
+    enabled?: boolean;
+    /**
+     * Creation date
+     */
+    created?: string | null;
+    /**
+     * Last update date
+     */
+    updated?: string | null;
+    metadata?: any;
+};
+

package/src/models/ContentPagination.ts

@@ -0,0 +1,30 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Serializer for content pagination metadata.
+ */
+export type ContentPagination = {
+    /**
+     * Total number of items
+     */
+    count: number;
+    /**
+     * URL for next page
+     */
+    next?: string | null;
+    /**
+     * URL for previous page
+     */
+    previous?: string | null;
+    /**
+     * Current page number
+     */
+    current_page: number;
+    /**
+     * Total number of pages
+     */
+    total_pages: number;
+};
+

package/src/models/ContentResponse.ts

@@ -0,0 +1,29 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+import type { ContentItem } from './ContentItem';
+import type { ContentPagination } from './ContentPagination';
+import type { ContentSummary } from './ContentSummary';
+/**
+ * Serializer for the complete content API response.
+ */
+export type ContentResponse = {
+    /**
+     * The metric type (course, program, pathway, skill)
+     */
+    metric: string;
+    /**
+     * Summary statistics for the metric
+     */
+    summary: ContentSummary;
+    /**
+     * Pagination metadata
+     */
+    pagination: ContentPagination;
+    /**
+     * List of content items
+     */
+    results: Array<ContentItem>;
+};
+

package/src/models/ContentSummary.ts

@@ -0,0 +1,14 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+import type { ContentAverages } from './ContentAverages';
+import type { ContentTotals } from './ContentTotals';
+/**
+ * Serializer for content summary data.
+ */
+export type ContentSummary = {
+    totals: ContentTotals;
+    averages: ContentAverages;
+};
+

package/src/models/ContentTotals.ts

@@ -0,0 +1,90 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Serializer for content summary totals.
+ */
+export type ContentTotals = {
+    /**
+     * Total number of learners
+     */
+    total_learners: number;
+    /**
+     * Total number of enrollments
+     */
+    total_enrollments: number;
+    /**
+     * Total number of courses
+     */
+    courses?: number;
+    /**
+     * Number of active courses
+     */
+    active_courses?: number;
+    /**
+     * Number of platform-owned courses
+     */
+    platform_courses?: number;
+    /**
+     * Number of external courses
+     */
+    external_courses?: number;
+    /**
+     * Total number of programs
+     */
+    programs?: number;
+    /**
+     * Number of active programs
+     */
+    active_programs?: number;
+    /**
+     * Number of platform-owned programs
+     */
+    platform_programs?: number;
+    /**
+     * Number of external programs
+     */
+    external_programs?: number;
+    /**
+     * Total number of pathways
+     */
+    pathways?: number;
+    /**
+     * Number of active pathways
+     */
+    active_pathways?: number;
+    /**
+     * Number of platform-owned pathways
+     */
+    platform_pathways?: number;
+    /**
+     * Number of external pathways
+     */
+    external_pathways?: number;
+    /**
+     * Total number of skills
+     */
+    skills?: number;
+    /**
+     * Number of active skills
+     */
+    active_skills?: number;
+    /**
+     * Number of platform-owned skills
+     */
+    platform_skills?: number;
+    /**
+     * Number of external skills
+     */
+    external_skills?: number;
+    /**
+     * Number of courses associated with skills
+     */
+    associated_courses?: number;
+    /**
+     * Number of learners with skills
+     */
+    learners_with_skills?: number;
+};
+