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

package/src/models/ContentDetailsPagination.ts

@@ -0,0 +1,30 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * 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/src/models/ContentDetailsResponse.ts

@@ -0,0 +1,18 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+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/src/models/ContentDetailsSummary.ts

@@ -0,0 +1,23 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+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/src/models/ContentDetailsTimeSeries.ts

@@ -0,0 +1,20 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+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/src/models/ContentDetailsTimeSeriesPoint.ts

@@ -0,0 +1,22 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * 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/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 { ContentDetailsResponse } from '../models/ContentDetailsResponse';
 import type { ContentResponse } from '../models/ContentResponse';
 import type { Count } from '../models/Count';
 import type { CourseCompletionPerCourse } from '../models/CourseCompletionPerCourse';
@@ -121,6 +122,80 @@ export class AiAnalyticsService {
             },
         });
     }
+    /**
+     * 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
+     */
+    public static getContentDetails({
+        contentId,
+        metric,
+        dateFilter = 'today',
+        endDate,
+        limit = 10,
+        page = 1,
+        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> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/api/analytics/content/details/{content_id}/',
+            path: {
+                'content_id': contentId,
+            },
+            query: {
+                'date_filter': dateFilter,
+                'end_date': endDate,
+                'limit': limit,
+                'metric': metric,
+                'page': page,
+                'platform_key': platformKey,
+                'search': search,
+                'start_date': startDate,
+                'time_metric': timeMetric,
+            },
+        });
+    }
     /**
      *
      * Retrieve a holistic snapshot of a learner across catalog enrollments, mentor

package/src/services/AnalyticsService.ts

@@ -2,6 +2,7 @@
 /* istanbul ignore file */
 /* tslint:disable */
 /* eslint-disable */
+import type { ContentDetailsResponse } from '../models/ContentDetailsResponse';
 import type { ContentResponse } from '../models/ContentResponse';
 import type { LearnerAnalyticsResponse } from '../models/LearnerAnalyticsResponse';
 import type { CancelablePromise } from '../core/CancelablePromise';
@@ -77,6 +78,80 @@ export class AnalyticsService {
             },
         });
     }
+    /**
+     * 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
+     */
+    public static getContentDetails({
+        contentId,
+        metric,
+        dateFilter = 'today',
+        endDate,
+        limit = 10,
+        page = 1,
+        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> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/api/analytics/content/details/{content_id}/',
+            path: {
+                'content_id': contentId,
+            },
+            query: {
+                'date_filter': dateFilter,
+                'end_date': endDate,
+                'limit': limit,
+                'metric': metric,
+                'page': page,
+                'platform_key': platformKey,
+                'search': search,
+                'start_date': startDate,
+                'time_metric': timeMetric,
+            },
+        });
+    }
     /**
      * Unified API endpoint for learner analytics.
      *