@iblai/iblai-api 4.391.0-core → 4.392.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.391.0-core',
113
+ VERSION: '4.392.0-core',
114
114
  WITH_CREDENTIALS: false,
115
115
  CREDENTIALS: 'include',
116
116
  TOKEN: undefined,
@@ -2553,7 +2553,7 @@ class AiAnalyticsService {
2553
2553
  page = 1,
2554
2554
  platformKey,
2555
2555
  search,
2556
- sortBy = 'name',
2556
+ sortBy = 'enrollments',
2557
2557
  startDate,
2558
2558
  usergroupIds
2559
2559
  }) {
@@ -6153,7 +6153,7 @@ class AnalyticsService {
6153
6153
  page = 1,
6154
6154
  platformKey,
6155
6155
  search,
6156
- sortBy = 'name',
6156
+ sortBy = 'enrollments',
6157
6157
  startDate,
6158
6158
  usergroupIds
6159
6159
  }) {
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.391.0-core',
111
+ VERSION: '4.392.0-core',
112
112
  WITH_CREDENTIALS: false,
113
113
  CREDENTIALS: 'include',
114
114
  TOKEN: undefined,
@@ -2551,7 +2551,7 @@ class AiAnalyticsService {
2551
2551
  page = 1,
2552
2552
  platformKey,
2553
2553
  search,
2554
- sortBy = 'name',
2554
+ sortBy = 'enrollments',
2555
2555
  startDate,
2556
2556
  usergroupIds
2557
2557
  }) {
@@ -6151,7 +6151,7 @@ class AnalyticsService {
6151
6151
  page = 1,
6152
6152
  platformKey,
6153
6153
  search,
6154
- sortBy = 'name',
6154
+ sortBy = 'enrollments',
6155
6155
  startDate,
6156
6156
  usergroupIds
6157
6157
  }) {
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.391.0-core',
117
+ VERSION: '4.392.0-core',
118
118
  WITH_CREDENTIALS: false,
119
119
  CREDENTIALS: 'include',
120
120
  TOKEN: undefined,
@@ -2557,7 +2557,7 @@
2557
2557
  page = 1,
2558
2558
  platformKey,
2559
2559
  search,
2560
- sortBy = 'name',
2560
+ sortBy = 'enrollments',
2561
2561
  startDate,
2562
2562
  usergroupIds
2563
2563
  }) {
@@ -6157,7 +6157,7 @@
6157
6157
  page = 1,
6158
6158
  platformKey,
6159
6159
  search,
6160
- sortBy = 'name',
6160
+ sortBy = 'enrollments',
6161
6161
  startDate,
6162
6162
  usergroupIds
6163
6163
  }) {
@@ -4,9 +4,17 @@ import type { ContentAnalytics } from './ContentAnalytics';
4
4
  */
5
5
  export type ContentItem = {
6
6
  /**
7
- * Content identifier
7
+ * Content identifier. Deprecated for programs: use program_id / program_key instead.
8
8
  */
9
9
  id: string;
10
+ /**
11
+ * Program code (metric=program only), e.g. '2025'
12
+ */
13
+ program_id?: string;
14
+ /**
15
+ * Program key 'program-v1:<org>+<program_id>' (metric=program only)
16
+ */
17
+ program_key?: string;
10
18
  /**
11
19
  * Content name
12
20
  */
@@ -135,12 +135,13 @@ export declare class AiAnalyticsService {
135
135
  */
136
136
  search?: string;
137
137
  /**
138
- * Sort order for results. 'active_enrollments' is only supported for course, program, and pathway metrics; it is ignored for skill.
138
+ * Sort order for results. Enrollment counts use the same learner scope as each item's analytics; ties are ordered by name. 'enrollments' and 'active_enrollments' apply to course, program and pathway metrics; skills are always ordered by name.
139
139
  *
140
- * * `name` - Name (default)
140
+ * * `enrollments` - Total enrollments (descending, default)
141
141
  * * `active_enrollments` - Active enrollments (descending)
142
+ * * `name` - Name (A-Z)
142
143
  */
143
- sortBy?: 'name' | 'active_enrollments';
144
+ sortBy?: 'enrollments' | 'active_enrollments' | 'name';
144
145
  startDate?: string;
145
146
  /**
146
147
  * Optional list of usergroup IDs to filter results
@@ -91,12 +91,13 @@ export declare class AnalyticsService {
91
91
  */
92
92
  search?: string;
93
93
  /**
94
- * Sort order for results. 'active_enrollments' is only supported for course, program, and pathway metrics; it is ignored for skill.
94
+ * Sort order for results. Enrollment counts use the same learner scope as each item's analytics; ties are ordered by name. 'enrollments' and 'active_enrollments' apply to course, program and pathway metrics; skills are always ordered by name.
95
95
  *
96
- * * `name` - Name (default)
96
+ * * `enrollments` - Total enrollments (descending, default)
97
97
  * * `active_enrollments` - Active enrollments (descending)
98
+ * * `name` - Name (A-Z)
98
99
  */
99
- sortBy?: 'name' | 'active_enrollments';
100
+ sortBy?: 'enrollments' | 'active_enrollments' | 'name';
100
101
  startDate?: string;
101
102
  /**
102
103
  * Optional list of usergroup IDs to filter results
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@iblai/iblai-api",
3
- "version": "4.391.0-core",
3
+ "version": "4.392.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.391.0-core
4
+ version: 4.392.0-core
5
5
  description: API for iblai
6
6
  paths:
7
7
  /api/analytics/content/:
@@ -134,16 +134,18 @@ paths:
134
134
  name: sort_by
135
135
  schema:
136
136
  enum:
137
- - name
137
+ - enrollments
138
138
  - active_enrollments
139
+ - name
139
140
  type: string
140
- default: name
141
+ default: enrollments
141
142
  minLength: 1
142
143
  description: |-
143
- Sort order for results. 'active_enrollments' is only supported for course, program, and pathway metrics; it is ignored for skill.
144
+ Sort order for results. Enrollment counts use the same learner scope as each item's analytics; ties are ordered by name. 'enrollments' and 'active_enrollments' apply to course, program and pathway metrics; skills are always ordered by name.
144
145
 
145
- * `name` - Name (default)
146
+ * `enrollments` - Total enrollments (descending, default)
146
147
  * `active_enrollments` - Active enrollments (descending)
148
+ * `name` - Name (A-Z)
147
149
  - in: query
148
150
  name: start_date
149
151
  schema:
@@ -44921,7 +44923,15 @@ components:
44921
44923
  properties:
44922
44924
  id:
44923
44925
  type: string
44924
- description: Content identifier
44926
+ description: 'Content identifier. Deprecated for programs: use program_id
44927
+ / program_key instead.'
44928
+ program_id:
44929
+ type: string
44930
+ description: Program code (metric=program only), e.g. '2025'
44931
+ program_key:
44932
+ type: string
44933
+ description: Program key 'program-v1:<org>+<program_id>' (metric=program
44934
+ only)
44925
44935
  name:
44926
44936
  type: string
44927
44937
  description: Content name
@@ -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.391.0-core',
24
+ VERSION: '4.392.0-core',
25
25
  WITH_CREDENTIALS: false,
26
26
  CREDENTIALS: 'include',
27
27
  TOKEN: undefined,
@@ -8,9 +8,17 @@ import type { ContentAnalytics } from './ContentAnalytics';
8
8
  */
9
9
  export type ContentItem = {
10
10
  /**
11
- * Content identifier
11
+ * Content identifier. Deprecated for programs: use program_id / program_key instead.
12
12
  */
13
13
  id: string;
14
+ /**
15
+ * Program code (metric=program only), e.g. '2025'
16
+ */
17
+ program_id?: string;
18
+ /**
19
+ * Program key 'program-v1:<org>+<program_id>' (metric=program only)
20
+ */
21
+ program_key?: string;
14
22
  /**
15
23
  * Content name
16
24
  */
@@ -99,7 +99,7 @@ export class AiAnalyticsService {
99
99
  page = 1,
100
100
  platformKey,
101
101
  search,
102
- sortBy = 'name',
102
+ sortBy = 'enrollments',
103
103
  startDate,
104
104
  usergroupIds,
105
105
  }: {
@@ -154,12 +154,13 @@ export class AiAnalyticsService {
154
154
  */
155
155
  search?: string,
156
156
  /**
157
- * Sort order for results. 'active_enrollments' is only supported for course, program, and pathway metrics; it is ignored for skill.
157
+ * Sort order for results. Enrollment counts use the same learner scope as each item's analytics; ties are ordered by name. 'enrollments' and 'active_enrollments' apply to course, program and pathway metrics; skills are always ordered by name.
158
158
  *
159
- * * `name` - Name (default)
159
+ * * `enrollments` - Total enrollments (descending, default)
160
160
  * * `active_enrollments` - Active enrollments (descending)
161
+ * * `name` - Name (A-Z)
161
162
  */
162
- sortBy?: 'name' | 'active_enrollments',
163
+ sortBy?: 'enrollments' | 'active_enrollments' | 'name',
163
164
  startDate?: string,
164
165
  /**
165
166
  * Optional list of usergroup IDs to filter results
@@ -55,7 +55,7 @@ export class AnalyticsService {
55
55
  page = 1,
56
56
  platformKey,
57
57
  search,
58
- sortBy = 'name',
58
+ sortBy = 'enrollments',
59
59
  startDate,
60
60
  usergroupIds,
61
61
  }: {
@@ -110,12 +110,13 @@ export class AnalyticsService {
110
110
  */
111
111
  search?: string,
112
112
  /**
113
- * Sort order for results. 'active_enrollments' is only supported for course, program, and pathway metrics; it is ignored for skill.
113
+ * Sort order for results. Enrollment counts use the same learner scope as each item's analytics; ties are ordered by name. 'enrollments' and 'active_enrollments' apply to course, program and pathway metrics; skills are always ordered by name.
114
114
  *
115
- * * `name` - Name (default)
115
+ * * `enrollments` - Total enrollments (descending, default)
116
116
  * * `active_enrollments` - Active enrollments (descending)
117
+ * * `name` - Name (A-Z)
117
118
  */
118
- sortBy?: 'name' | 'active_enrollments',
119
+ sortBy?: 'enrollments' | 'active_enrollments' | 'name',
119
120
  startDate?: string,
120
121
  /**
121
122
  * Optional list of usergroup IDs to filter results