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

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

@@ -0,0 +1,25 @@
+/**
+ * Serializer for pagination information in content details response.
+ */
+export type ContentDetailsPagination = {
+    /**
+     * Total learner records
+     */
+    count: number;
+    /**
+     * Relative URL for the next page
+     */
+    next?: string | null;
+    /**
+     * Relative URL for the previous page
+     */
+    previous?: string | null;
+    /**
+     * Current page number
+     */
+    current_page: number;
+    /**
+     * Total number of pages
+     */
+    total_pages: number;
+};

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

@@ -0,0 +1,13 @@
+import type { ContentDetailsContentInfo } from './ContentDetailsContentInfo';
+import type { ContentDetailsLearner } from './ContentDetailsLearner';
+import type { ContentDetailsPagination } from './ContentDetailsPagination';
+import type { ContentDetailsSummary } from './ContentDetailsSummary';
+/**
+ * Serializer for the content details API response.
+ */
+export type ContentDetailsResponse = {
+    content_info: ContentDetailsContentInfo;
+    summary: ContentDetailsSummary;
+    pagination: ContentDetailsPagination;
+    learners: Array<ContentDetailsLearner>;
+};

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

@@ -0,0 +1,18 @@
+import type { ContentDetailsTimeSeries } from './ContentDetailsTimeSeries';
+/**
+ * Serializer for summary data in the content details endpoint.
+ */
+export type ContentDetailsSummary = {
+    /**
+     * Total counts related to the content item
+     */
+    totals: Record<string, number>;
+    /**
+     * Average values related to the content item
+     */
+    averages: Record<string, number | null>;
+    /**
+     * Optional time series data for the requested metric
+     */
+    time_series?: ContentDetailsTimeSeries;
+};

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

@@ -0,0 +1,15 @@
+import type { ContentDetailsTimeSeriesPoint } from './ContentDetailsTimeSeriesPoint';
+/**
+ * Serializer describing the time series block.
+ */
+export type ContentDetailsTimeSeries = {
+    /**
+     * Metric represented in the time series
+     */
+    metric: string;
+    /**
+     * Aggregation interval (e.g., month)
+     */
+    interval: string;
+    data: Array<ContentDetailsTimeSeriesPoint>;
+};

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

@@ -0,0 +1,17 @@
+/**
+ * Serializer for individual time series points in content details response.
+ */
+export type ContentDetailsTimeSeriesPoint = {
+    /**
+     * ISO8601 timestamp representing the aggregated period
+     */
+    period: string;
+    /**
+     * Value for the requested metric during the period
+     */
+    value: number;
+    /**
+     * Average value for the period (used for ratings)
+     */
+    average?: number | null;
+};

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

@@ -4,6 +4,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 { ContentDetailsResponse } from '../models/ContentDetailsResponse';
 import type { ContentResponse } from '../models/ContentResponse';
 import type { Count } from '../models/Count';
 import type { CourseCompletionPerCourse } from '../models/CourseCompletionPerCourse';
@@ -99,6 +100,50 @@ export declare class AiAnalyticsService {
          */
         platformKey?: string | null;
     }): CancelablePromise<ContentResponse>;
+    /**
+     * Get Content Details
+     * Retrieve detailed analytics for a specific content item including summary statistics, learner-level data, and optional time series information.
+     * @returns ContentDetailsResponse
+     * @throws ApiError
+     */
+    static getContentDetails({ contentId, metric, dateFilter, endDate, limit, page, platformKey, search, startDate, timeMetric, }: {
+        contentId: string;
+        /**
+         * Content type to fetch (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';
+        /**
+         * * `today` - Today only
+         * * `7d` - Last 7 days
+         * * `30d` - Last 30 days
+         * * `90d` - Last 90 days
+         * * `all_time` - All time
+         * * `custom` - Custom date range
+         */
+        dateFilter?: 'today' | '7d' | '30d' | '90d' | 'all_time' | 'custom';
+        endDate?: string;
+        /**
+         * Number of learner records per page
+         */
+        limit?: number;
+        page?: number;
+        platformKey?: string;
+        search?: string;
+        startDate?: string;
+        /**
+         * Optional time series metric (enrollments, completions, ratings)
+         */
+        timeMetric?: string | null;
+    }): CancelablePromise<ContentDetailsResponse>;
     /**
      *
      * Retrieve a holistic snapshot of a learner across catalog enrollments, mentor

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

@@ -1,3 +1,4 @@
+import type { ContentDetailsResponse } from '../models/ContentDetailsResponse';
 import type { ContentResponse } from '../models/ContentResponse';
 import type { LearnerAnalyticsResponse } from '../models/LearnerAnalyticsResponse';
 import type { CancelablePromise } from '../core/CancelablePromise';
@@ -55,6 +56,50 @@ export declare class AnalyticsService {
          */
         platformKey?: string | null;
     }): CancelablePromise<ContentResponse>;
+    /**
+     * Get Content Details
+     * Retrieve detailed analytics for a specific content item including summary statistics, learner-level data, and optional time series information.
+     * @returns ContentDetailsResponse
+     * @throws ApiError
+     */
+    static getContentDetails({ contentId, metric, dateFilter, endDate, limit, page, platformKey, search, startDate, timeMetric, }: {
+        contentId: string;
+        /**
+         * Content type to fetch (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';
+        /**
+         * * `today` - Today only
+         * * `7d` - Last 7 days
+         * * `30d` - Last 30 days
+         * * `90d` - Last 90 days
+         * * `all_time` - All time
+         * * `custom` - Custom date range
+         */
+        dateFilter?: 'today' | '7d' | '30d' | '90d' | 'all_time' | 'custom';
+        endDate?: string;
+        /**
+         * Number of learner records per page
+         */
+        limit?: number;
+        page?: number;
+        platformKey?: string;
+        search?: string;
+        startDate?: string;
+        /**
+         * Optional time series metric (enrollments, completions, ratings)
+         */
+        timeMetric?: string | null;
+    }): CancelablePromise<ContentDetailsResponse>;
     /**
      * Unified API endpoint for learner analytics.
      *

package/package.json

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

package/sdk_schema.yml

@@ -1,7 +1,7 @@
 openapi: 3.0.3
 info:
   title: ibl-data-manager
-  version: 4.45.1-core
+  version: 4.46.0-core
   description: API for iblai
 paths:
   /api/analytics/content/:
@@ -100,6 +100,133 @@ paths:
               schema:
                 description: Internal server error
           description: ''
+  /api/analytics/content/details/{content_id}/:
+    get:
+      operationId: get_content_details
+      description: Retrieve detailed analytics for a specific content item including
+        summary statistics, learner-level data, and optional time series information.
+      summary: Get Content Details
+      parameters:
+      - in: path
+        name: content_id
+        schema:
+          type: string
+        required: true
+      - in: query
+        name: date_filter
+        schema:
+          enum:
+          - today
+          - 7d
+          - 30d
+          - 90d
+          - all_time
+          - custom
+          type: string
+          default: today
+          minLength: 1
+        description: |-
+          * `today` - Today only
+          * `7d` - Last 7 days
+          * `30d` - Last 30 days
+          * `90d` - Last 90 days
+          * `all_time` - All time
+          * `custom` - Custom date range
+      - in: query
+        name: end_date
+        schema:
+          type: string
+          format: date
+      - in: query
+        name: limit
+        schema:
+          type: integer
+          maximum: 30
+          minimum: 1
+          default: 10
+        description: Number of learner records per page
+      - in: query
+        name: metric
+        schema:
+          enum:
+          - course
+          - courses
+          - program
+          - programs
+          - pathway
+          - pathways
+          - skill
+          - skills
+          type: string
+          minLength: 1
+        description: |-
+          Content type to fetch (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
+      - in: query
+        name: platform_key
+        schema:
+          type: string
+          minLength: 1
+      - in: query
+        name: search
+        schema:
+          type: string
+      - in: query
+        name: start_date
+        schema:
+          type: string
+          format: date
+      - in: query
+        name: time_metric
+        schema:
+          type: string
+          nullable: true
+        description: Optional time series metric (enrollments, completions, ratings)
+      tags:
+      - ai-analytics
+      - analytics
+      security:
+      - PlatformApiKeyAuthentication: []
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ContentDetailsResponse'
+          description: ''
+        '400':
+          content:
+            application/json:
+              schema:
+                description: Invalid request parameters
+          description: ''
+        '404':
+          content:
+            application/json:
+              schema:
+                description: Content not found or 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
@@ -30966,6 +31093,204 @@ components:
           type: number
           format: double
           description: Average courses per skill
+    ContentDetailsContentInfo:
+      type: object
+      description: Serializer for the content information block.
+      properties:
+        id:
+          type: string
+          description: Identifier for the content item
+        name:
+          type: string
+          nullable: true
+        type:
+          type: string
+          description: Content type (course, program, pathway, skill)
+        slug:
+          type: string
+          nullable: true
+        platform:
+          type: string
+          nullable: true
+        external:
+          type: boolean
+          description: Whether the content is external to the platform
+        metadata:
+          type: object
+          additionalProperties: {}
+          description: Metadata associated with the content item
+      required:
+      - external
+      - id
+      - type
+    ContentDetailsLearner:
+      type: object
+      description: Serializer for individual learner entries in content details.
+      properties:
+        user_id:
+          type: integer
+          description: Learner identifier
+        username:
+          type: string
+          nullable: true
+          description: Learner username
+        email:
+          type: string
+          format: email
+          nullable: true
+          description: Learner email
+        name:
+          type: string
+          nullable: true
+          description: Learner display name
+        enrollment_date:
+          type: string
+          format: date-time
+          nullable: true
+          description: Date the learner enrolled in the content
+        completion_status:
+          type: string
+          description: Completion status for the learner
+        completion_percentage:
+          type: number
+          format: double
+          nullable: true
+          description: Learner completion percentage
+        last_activity:
+          type: string
+          format: date-time
+          nullable: true
+          description: Last activity timestamp for the learner
+        rating:
+          type: number
+          format: double
+          nullable: true
+          description: Learner rating for the content, if available
+        review:
+          type: string
+          nullable: true
+          description: Learner review content, if available
+        details:
+          type: object
+          additionalProperties: {}
+          description: Additional learner-specific metadata
+      required:
+      - completion_percentage
+      - completion_status
+      - email
+      - enrollment_date
+      - last_activity
+      - name
+      - rating
+      - review
+      - user_id
+      - username
+    ContentDetailsPagination:
+      type: object
+      description: Serializer for pagination information in content details response.
+      properties:
+        count:
+          type: integer
+          description: Total learner records
+        next:
+          type: string
+          nullable: true
+          description: Relative URL for the next page
+        previous:
+          type: string
+          nullable: true
+          description: Relative URL for the 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
+    ContentDetailsResponse:
+      type: object
+      description: Serializer for the content details API response.
+      properties:
+        content_info:
+          $ref: '#/components/schemas/ContentDetailsContentInfo'
+        summary:
+          $ref: '#/components/schemas/ContentDetailsSummary'
+        pagination:
+          $ref: '#/components/schemas/ContentDetailsPagination'
+        learners:
+          type: array
+          items:
+            $ref: '#/components/schemas/ContentDetailsLearner'
+      required:
+      - content_info
+      - learners
+      - pagination
+      - summary
+    ContentDetailsSummary:
+      type: object
+      description: Serializer for summary data in the content details endpoint.
+      properties:
+        totals:
+          type: object
+          additionalProperties:
+            type: number
+            format: double
+          description: Total counts related to the content item
+        averages:
+          type: object
+          additionalProperties:
+            type: number
+            format: double
+            nullable: true
+          description: Average values related to the content item
+        time_series:
+          allOf:
+          - $ref: '#/components/schemas/ContentDetailsTimeSeries'
+          description: Optional time series data for the requested metric
+      required:
+      - averages
+      - totals
+    ContentDetailsTimeSeries:
+      type: object
+      description: Serializer describing the time series block.
+      properties:
+        metric:
+          type: string
+          description: Metric represented in the time series
+        interval:
+          type: string
+          description: Aggregation interval (e.g., month)
+        data:
+          type: array
+          items:
+            $ref: '#/components/schemas/ContentDetailsTimeSeriesPoint'
+      required:
+      - data
+      - interval
+      - metric
+    ContentDetailsTimeSeriesPoint:
+      type: object
+      description: Serializer for individual time series points in content details
+        response.
+      properties:
+        period:
+          type: string
+          description: ISO8601 timestamp representing the aggregated period
+        value:
+          type: number
+          format: double
+          description: Value for the requested metric during the period
+        average:
+          type: number
+          format: double
+          nullable: true
+          description: Average value for the period (used for ratings)
+      required:
+      - period
+      - value
     ContentItem:
       type: object
       description: Serializer for individual content items.

package/src/core/OpenAPI.ts

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

package/src/index.ts

@@ -57,6 +57,13 @@ 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 { ContentDetailsContentInfo } from './models/ContentDetailsContentInfo';
+export type { ContentDetailsLearner } from './models/ContentDetailsLearner';
+export type { ContentDetailsPagination } from './models/ContentDetailsPagination';
+export type { ContentDetailsResponse } from './models/ContentDetailsResponse';
+export type { ContentDetailsSummary } from './models/ContentDetailsSummary';
+export type { ContentDetailsTimeSeries } from './models/ContentDetailsTimeSeries';
+export type { ContentDetailsTimeSeriesPoint } from './models/ContentDetailsTimeSeriesPoint';
 export type { ContentItem } from './models/ContentItem';
 export type { ContentPagination } from './models/ContentPagination';
 export type { ContentResponse } from './models/ContentResponse';

package/src/models/ContentDetailsContentInfo.ts

@@ -0,0 +1,29 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Serializer for the content information block.
+ */
+export type ContentDetailsContentInfo = {
+    /**
+     * Identifier for the content item
+     */
+    id: string;
+    name?: string | null;
+    /**
+     * Content type (course, program, pathway, skill)
+     */
+    type: string;
+    slug?: string | null;
+    platform?: string | null;
+    /**
+     * Whether the content is external to the platform
+     */
+    external: boolean;
+    /**
+     * Metadata associated with the content item
+     */
+    metadata?: Record<string, any>;
+};
+

package/src/models/ContentDetailsLearner.ts

@@ -0,0 +1,54 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Serializer for individual learner entries in content details.
+ */
+export type ContentDetailsLearner = {
+    /**
+     * Learner identifier
+     */
+    user_id: number;
+    /**
+     * Learner username
+     */
+    username: string | null;
+    /**
+     * Learner email
+     */
+    email: string | null;
+    /**
+     * Learner display name
+     */
+    name: string | null;
+    /**
+     * Date the learner enrolled in the content
+     */
+    enrollment_date: string | null;
+    /**
+     * Completion status for the learner
+     */
+    completion_status: string;
+    /**
+     * Learner completion percentage
+     */
+    completion_percentage: number | null;
+    /**
+     * Last activity timestamp for the learner
+     */
+    last_activity: string | null;
+    /**
+     * Learner rating for the content, if available
+     */
+    rating: number | null;
+    /**
+     * Learner review content, if available
+     */
+    review: string | null;
+    /**
+     * Additional learner-specific metadata
+     */
+    details?: Record<string, any>;
+};
+