@iblai/iblai-api 4.404.0-core → 4.405.0-core

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.cjs.js CHANGED
@@ -110,7 +110,7 @@ class CancelablePromise {
110
110
 
111
111
  const OpenAPI = {
112
112
  BASE: 'https://base.manager.iblai.app',
113
- VERSION: '4.404.0-core',
113
+ VERSION: '4.405.0-core',
114
114
  WITH_CREDENTIALS: false,
115
115
  CREDENTIALS: 'include',
116
116
  TOKEN: undefined,
package/dist/index.esm.js CHANGED
@@ -108,7 +108,7 @@ class CancelablePromise {
108
108
 
109
109
  const OpenAPI = {
110
110
  BASE: 'https://base.manager.iblai.app',
111
- VERSION: '4.404.0-core',
111
+ VERSION: '4.405.0-core',
112
112
  WITH_CREDENTIALS: false,
113
113
  CREDENTIALS: 'include',
114
114
  TOKEN: undefined,
package/dist/index.umd.js CHANGED
@@ -114,7 +114,7 @@
114
114
 
115
115
  const OpenAPI = {
116
116
  BASE: 'https://base.manager.iblai.app',
117
- VERSION: '4.404.0-core',
117
+ VERSION: '4.405.0-core',
118
118
  WITH_CREDENTIALS: false,
119
119
  CREDENTIALS: 'include',
120
120
  TOKEN: undefined,
@@ -30,4 +30,16 @@ export type ContentAverages = {
30
30
  * Average time spent per learner in seconds (courses only)
31
31
  */
32
32
  time_per_learner?: number;
33
+ /**
34
+ * Average completion rate for completions within the window
35
+ */
36
+ period_completion_rate?: number;
37
+ /**
38
+ * Average rating for reviews within the window (course/program)
39
+ */
40
+ period_average_rating?: number;
41
+ /**
42
+ * Average time per learner within the window (courses only)
43
+ */
44
+ period_time_per_learner?: number;
33
45
  };
@@ -11,4 +11,12 @@ export type ContentSummary = {
11
11
  * Time spent over time data (courses only, when include_overtime=true)
12
12
  */
13
13
  overtime?: Array<OvertimeDataPoint>;
14
+ /**
15
+ * Start of the selected date_filter window (inclusive)
16
+ */
17
+ period_start_date?: string;
18
+ /**
19
+ * End of the selected date_filter window (inclusive)
20
+ */
21
+ period_end_date?: string;
14
22
  };
@@ -86,4 +86,20 @@ export type ContentTotals = {
86
86
  * Number of learners with skills
87
87
  */
88
88
  learners_with_skills?: number;
89
+ /**
90
+ * Enrollments created within the selected date_filter window
91
+ */
92
+ period_total_enrollments?: number;
93
+ /**
94
+ * Active enrollments created within the window
95
+ */
96
+ period_active_enrollments?: number;
97
+ /**
98
+ * Distinct learners who enrolled within the window
99
+ */
100
+ period_total_learners?: number;
101
+ /**
102
+ * Time spent in seconds within the window (courses only)
103
+ */
104
+ period_total_time_spent?: number;
89
105
  };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@iblai/iblai-api",
3
- "version": "4.404.0-core",
3
+ "version": "4.405.0-core",
4
4
  "main": "dist/index.cjs.js",
5
5
  "module": "dist/index.esm.js",
6
6
  "type": "module",
package/sdk_schema.yml CHANGED
@@ -1,7 +1,7 @@
1
1
  openapi: 3.0.3
2
2
  info:
3
3
  title: ibl-data-manager
4
- version: 4.404.0-core
4
+ version: 4.405.0-core
5
5
  description: API for iblai
6
6
  paths:
7
7
  /api/analytics/content/:
@@ -44719,6 +44719,18 @@ components:
44719
44719
  type: number
44720
44720
  format: double
44721
44721
  description: Average time spent per learner in seconds (courses only)
44722
+ period_completion_rate:
44723
+ type: number
44724
+ format: double
44725
+ description: Average completion rate for completions within the window
44726
+ period_average_rating:
44727
+ type: number
44728
+ format: double
44729
+ description: Average rating for reviews within the window (course/program)
44730
+ period_time_per_learner:
44731
+ type: number
44732
+ format: double
44733
+ description: Average time per learner within the window (courses only)
44722
44734
  ContentDetailsContentInfo:
44723
44735
  type: object
44724
44736
  description: Serializer for the content information block.
@@ -45041,6 +45053,14 @@ components:
45041
45053
  items:
45042
45054
  $ref: '#/components/schemas/OvertimeDataPoint'
45043
45055
  description: Time spent over time data (courses only, when include_overtime=true)
45056
+ period_start_date:
45057
+ type: string
45058
+ format: date
45059
+ description: Start of the selected date_filter window (inclusive)
45060
+ period_end_date:
45061
+ type: string
45062
+ format: date
45063
+ description: End of the selected date_filter window (inclusive)
45044
45064
  required:
45045
45065
  - averages
45046
45066
  - totals
@@ -45111,6 +45131,18 @@ components:
45111
45131
  learners_with_skills:
45112
45132
  type: integer
45113
45133
  description: Number of learners with skills
45134
+ period_total_enrollments:
45135
+ type: integer
45136
+ description: Enrollments created within the selected date_filter window
45137
+ period_active_enrollments:
45138
+ type: integer
45139
+ description: Active enrollments created within the window
45140
+ period_total_learners:
45141
+ type: integer
45142
+ description: Distinct learners who enrolled within the window
45143
+ period_total_time_spent:
45144
+ type: integer
45145
+ description: Time spent in seconds within the window (courses only)
45114
45146
  required:
45115
45147
  - total_enrollments
45116
45148
  - total_learners
@@ -21,7 +21,7 @@ export type OpenAPIConfig = {
21
21
 
22
22
  export const OpenAPI: OpenAPIConfig = {
23
23
  BASE: 'https://base.manager.iblai.app',
24
- VERSION: '4.404.0-core',
24
+ VERSION: '4.405.0-core',
25
25
  WITH_CREDENTIALS: false,
26
26
  CREDENTIALS: 'include',
27
27
  TOKEN: undefined,
@@ -34,5 +34,17 @@ export type ContentAverages = {
34
34
  * Average time spent per learner in seconds (courses only)
35
35
  */
36
36
  time_per_learner?: number;
37
+ /**
38
+ * Average completion rate for completions within the window
39
+ */
40
+ period_completion_rate?: number;
41
+ /**
42
+ * Average rating for reviews within the window (course/program)
43
+ */
44
+ period_average_rating?: number;
45
+ /**
46
+ * Average time per learner within the window (courses only)
47
+ */
48
+ period_time_per_learner?: number;
37
49
  };
38
50
 
@@ -15,5 +15,13 @@ export type ContentSummary = {
15
15
  * Time spent over time data (courses only, when include_overtime=true)
16
16
  */
17
17
  overtime?: Array<OvertimeDataPoint>;
18
+ /**
19
+ * Start of the selected date_filter window (inclusive)
20
+ */
21
+ period_start_date?: string;
22
+ /**
23
+ * End of the selected date_filter window (inclusive)
24
+ */
25
+ period_end_date?: string;
18
26
  };
19
27
 
@@ -90,5 +90,21 @@ export type ContentTotals = {
90
90
  * Number of learners with skills
91
91
  */
92
92
  learners_with_skills?: number;
93
+ /**
94
+ * Enrollments created within the selected date_filter window
95
+ */
96
+ period_total_enrollments?: number;
97
+ /**
98
+ * Active enrollments created within the window
99
+ */
100
+ period_active_enrollments?: number;
101
+ /**
102
+ * Distinct learners who enrolled within the window
103
+ */
104
+ period_total_learners?: number;
105
+ /**
106
+ * Time spent in seconds within the window (courses only)
107
+ */
108
+ period_total_time_spent?: number;
93
109
  };
94
110