@iblai/iblai-api 3.48.3-ai-plus → 3.48.4-ai
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 +5918 -6748
- package/dist/index.cjs.js.map +1 -1
- package/dist/index.esm.js +5919 -6747
- package/dist/index.esm.js.map +1 -1
- package/dist/index.umd.js +5918 -6748
- package/dist/index.umd.js.map +1 -1
- package/dist/types/index.d.ts +1 -40
- package/dist/types/models/{VoiceProviderEnum.d.ts → ProviderEnum.d.ts} +1 -1
- package/dist/types/models/Voice.d.ts +2 -2
- package/dist/types/services/AiAccountService.d.ts +66 -41
- package/dist/types/services/AiAnalyticsService.d.ts +2021 -923
- package/dist/types/services/AiIndexService.d.ts +78 -71
- package/dist/types/services/AiMarketingService.d.ts +17 -13
- package/dist/types/services/AiMediaService.d.ts +45 -41
- package/dist/types/services/AiMentorService.d.ts +1545 -1037
- package/dist/types/services/AiPromptService.d.ts +342 -228
- package/dist/types/services/AnalyticsService.d.ts +42 -13
- package/dist/types/services/AudienceService.d.ts +345 -149
- package/dist/types/services/CareerService.d.ts +117 -90
- package/dist/types/services/CatalogService.d.ts +3735 -1072
- package/dist/types/services/CoreService.d.ts +441 -215
- package/dist/types/services/CredentialsService.d.ts +173 -138
- package/dist/types/services/DepartmentsService.d.ts +53 -16
- package/dist/types/services/EngagementService.d.ts +459 -179
- package/dist/types/services/FeaturesService.d.ts +16 -7
- package/dist/types/services/FinanceService.d.ts +49 -20
- package/dist/types/services/MediaResourcesService.d.ts +243 -67
- package/dist/types/services/NotificationBuilderService.d.ts +31 -17
- package/dist/types/services/NotificationService.d.ts +56 -49
- package/dist/types/services/OrgsService.d.ts +106 -77
- package/dist/types/services/OverviewService.d.ts +154 -55
- package/dist/types/services/PerformanceService.d.ts +132 -56
- package/dist/types/services/PerlearnerService.d.ts +431 -217
- package/dist/types/services/PlatformService.d.ts +221 -116
- package/dist/types/services/ProviderAssociationService.d.ts +3 -2
- package/dist/types/services/ProvidersService.d.ts +27 -18
- package/dist/types/services/ProvisionService.d.ts +3 -2
- package/dist/types/services/RecommendationsService.d.ts +3 -3
- package/dist/types/services/ReportsService.d.ts +22 -16
- package/dist/types/services/RolesService.d.ts +8 -6
- package/dist/types/services/SearchService.d.ts +730 -195
- package/dist/types/services/ServiceService.d.ts +33 -29
- package/dist/types/services/SkillsService.d.ts +40 -32
- package/dist/types/services/UserGroupsService.d.ts +53 -16
- package/package.json +1 -1
- package/src/core/OpenAPI.ts +1 -1
- package/src/index.ts +1 -40
- package/src/models/{VoiceProviderEnum.ts → ProviderEnum.ts} +1 -1
- package/src/models/Voice.ts +2 -2
- package/src/services/AiAccountService.ts +81 -55
- package/src/services/AiAnalyticsService.ts +2422 -1181
- package/src/services/AiIndexService.ts +112 -87
- package/src/services/AiMarketingService.ts +25 -16
- package/src/services/AiMediaService.ts +67 -51
- package/src/services/AiMentorService.ts +2105 -1265
- package/src/services/AiPromptService.ts +484 -275
- package/src/services/AnalyticsService.ts +45 -16
- package/src/services/AudienceService.ts +380 -184
- package/src/services/CareerService.ts +144 -117
- package/src/services/CatalogService.ts +3995 -1332
- package/src/services/CoreService.ts +523 -291
- package/src/services/CredentialsService.ts +253 -173
- package/src/services/DepartmentsService.ts +56 -19
- package/src/services/EngagementService.ts +528 -236
- package/src/services/FeaturesService.ts +19 -10
- package/src/services/FinanceService.ts +54 -25
- package/src/services/MediaResourcesService.ts +251 -75
- package/src/services/NotificationBuilderService.ts +36 -22
- package/src/services/NotificationService.ts +73 -61
- package/src/services/OrgsService.ts +135 -106
- package/src/services/OverviewService.ts +172 -73
- package/src/services/PerformanceService.ts +153 -77
- package/src/services/PerlearnerService.ts +591 -279
- package/src/services/PlatformService.ts +278 -157
- package/src/services/ProviderAssociationService.ts +4 -3
- package/src/services/ProvidersService.ts +36 -27
- package/src/services/ProvisionService.ts +4 -3
- package/src/services/RecommendationsService.ts +5 -4
- package/src/services/ReportsService.ts +28 -22
- package/src/services/RolesService.ts +10 -8
- package/src/services/SearchService.ts +771 -236
- package/src/services/ServiceService.ts +49 -39
- package/src/services/SkillsService.ts +56 -44
- package/src/services/UserGroupsService.ts +56 -19
- package/dist/types/models/Bot.d.ts +0 -15
- package/dist/types/models/BotCommand.d.ts +0 -6
- package/dist/types/models/BotCreate.d.ts +0 -12
- package/dist/types/models/DataSet.d.ts +0 -21
- package/dist/types/models/DataSetCreate.d.ts +0 -12
- package/dist/types/models/DataSetStatusEnum.d.ts +0 -12
- package/dist/types/models/DiscordConfig.d.ts +0 -7
- package/dist/types/models/DiscordUserConfig.d.ts +0 -10
- package/dist/types/models/DiscordWebhook.d.ts +0 -6
- package/dist/types/models/PaginatedDataSetList.d.ts +0 -7
- package/dist/types/models/PaginatedTrainingList.d.ts +0 -7
- package/dist/types/models/PatchedBotCommand.d.ts +0 -6
- package/dist/types/models/PatchedBotCreate.d.ts +0 -12
- package/dist/types/models/PatchedDataSet.d.ts +0 -21
- package/dist/types/models/PatchedDiscordConfig.d.ts +0 -7
- package/dist/types/models/PatchedDiscordUserConfig.d.ts +0 -10
- package/dist/types/models/PatchedSlackConfig.d.ts +0 -8
- package/dist/types/models/PatchedSlackUserConfig.d.ts +0 -17
- package/dist/types/models/PatchedTeamsConfig.d.ts +0 -7
- package/dist/types/models/PatchedTrainingCreate.d.ts +0 -31
- package/dist/types/models/PatchedWebexConfig.d.ts +0 -10
- package/dist/types/models/PatchedWhatsappConfig.d.ts +0 -11
- package/dist/types/models/PatchedWhatsappUserConfig.d.ts +0 -10
- package/dist/types/models/Provider05cEnum.d.ts +0 -14
- package/dist/types/models/Provider63aEnum.d.ts +0 -6
- package/dist/types/models/SlackConfig.d.ts +0 -8
- package/dist/types/models/SlackUserConfig.d.ts +0 -17
- package/dist/types/models/SlackWebhook.d.ts +0 -6
- package/dist/types/models/TeamsConfig.d.ts +0 -7
- package/dist/types/models/TeamsWebhook.d.ts +0 -17
- package/dist/types/models/Training.d.ts +0 -41
- package/dist/types/models/TrainingCreate.d.ts +0 -31
- package/dist/types/models/WebexConfig.d.ts +0 -10
- package/dist/types/models/WebexWebhook.d.ts +0 -4
- package/dist/types/models/WhatAppWebHook.d.ts +0 -3
- package/dist/types/models/WhatsappConfig.d.ts +0 -11
- package/dist/types/models/WhatsappUserConfig.d.ts +0 -10
- package/dist/types/services/AiBotService.d.ts +0 -486
- package/dist/types/services/AiFinetuningService.d.ts +0 -162
- package/src/models/Bot.ts +0 -20
- package/src/models/BotCommand.ts +0 -11
- package/src/models/BotCreate.ts +0 -17
- package/src/models/DataSet.ts +0 -26
- package/src/models/DataSetCreate.ts +0 -17
- package/src/models/DataSetStatusEnum.ts +0 -16
- package/src/models/DiscordConfig.ts +0 -12
- package/src/models/DiscordUserConfig.ts +0 -15
- package/src/models/DiscordWebhook.ts +0 -11
- package/src/models/PaginatedDataSetList.ts +0 -12
- package/src/models/PaginatedTrainingList.ts +0 -12
- package/src/models/PatchedBotCommand.ts +0 -11
- package/src/models/PatchedBotCreate.ts +0 -17
- package/src/models/PatchedDataSet.ts +0 -26
- package/src/models/PatchedDiscordConfig.ts +0 -12
- package/src/models/PatchedDiscordUserConfig.ts +0 -15
- package/src/models/PatchedSlackConfig.ts +0 -13
- package/src/models/PatchedSlackUserConfig.ts +0 -22
- package/src/models/PatchedTeamsConfig.ts +0 -12
- package/src/models/PatchedTrainingCreate.ts +0 -36
- package/src/models/PatchedWebexConfig.ts +0 -15
- package/src/models/PatchedWhatsappConfig.ts +0 -16
- package/src/models/PatchedWhatsappUserConfig.ts +0 -15
- package/src/models/Provider05cEnum.ts +0 -18
- package/src/models/Provider63aEnum.ts +0 -10
- package/src/models/SlackConfig.ts +0 -13
- package/src/models/SlackUserConfig.ts +0 -22
- package/src/models/SlackWebhook.ts +0 -11
- package/src/models/TeamsConfig.ts +0 -12
- package/src/models/TeamsWebhook.ts +0 -22
- package/src/models/Training.ts +0 -46
- package/src/models/TrainingCreate.ts +0 -36
- package/src/models/WebexConfig.ts +0 -15
- package/src/models/WebexWebhook.ts +0 -9
- package/src/models/WhatAppWebHook.ts +0 -8
- package/src/models/WhatsappConfig.ts +0 -16
- package/src/models/WhatsappUserConfig.ts +0 -15
- package/src/services/AiBotService.ts +0 -1174
- package/src/services/AiFinetuningService.ts +0 -402
|
@@ -84,18 +84,34 @@ export declare class AiAnalyticsService {
|
|
|
84
84
|
* Default time range is the last 7 days if no dates are specified.
|
|
85
85
|
*
|
|
86
86
|
* An active user is defined as a user with any activity within the past 30 days.
|
|
87
|
-
* @param org
|
|
88
|
-
* @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
|
|
89
|
-
* @param endDate end date. ISO 8601
|
|
90
|
-
* @param format Format
|
|
91
|
-
*
|
|
92
|
-
* * `json` - json
|
|
93
|
-
* @param includeMainPlatform Include main platform data
|
|
94
|
-
* @param startDate start date. ISO 8601
|
|
95
87
|
* @returns OvertimeWithChangeInfo
|
|
96
88
|
* @throws ApiError
|
|
97
89
|
*/
|
|
98
|
-
static aiAnalyticsAudienceOrgsActiveUsersOverTimeRetrieve(org
|
|
90
|
+
static aiAnalyticsAudienceOrgsActiveUsersOverTimeRetrieve({ org, departmentId, endDate, format, includeMainPlatform, startDate, }: {
|
|
91
|
+
org: string;
|
|
92
|
+
/**
|
|
93
|
+
* When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
|
|
94
|
+
*/
|
|
95
|
+
departmentId?: number;
|
|
96
|
+
/**
|
|
97
|
+
* end date. ISO 8601
|
|
98
|
+
*/
|
|
99
|
+
endDate?: string;
|
|
100
|
+
/**
|
|
101
|
+
* Format
|
|
102
|
+
*
|
|
103
|
+
* * `json` - json
|
|
104
|
+
*/
|
|
105
|
+
format?: 'json';
|
|
106
|
+
/**
|
|
107
|
+
* Include main platform data
|
|
108
|
+
*/
|
|
109
|
+
includeMainPlatform?: boolean;
|
|
110
|
+
/**
|
|
111
|
+
* start date. ISO 8601
|
|
112
|
+
*/
|
|
113
|
+
startDate?: string;
|
|
114
|
+
}): CancelablePromise<OvertimeWithChangeInfo>;
|
|
99
115
|
/**
|
|
100
116
|
* Get active user counts on a per-course basis.
|
|
101
117
|
*
|
|
@@ -110,18 +126,34 @@ export declare class AiAnalyticsService {
|
|
|
110
126
|
* A list of courses with their active user counts.
|
|
111
127
|
*
|
|
112
128
|
* Default time range is the last 7 days if no dates are specified.
|
|
113
|
-
* @param org
|
|
114
|
-
* @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
|
|
115
|
-
* @param endDate end date. ISO 8601
|
|
116
|
-
* @param format Format
|
|
117
|
-
*
|
|
118
|
-
* * `json` - json
|
|
119
|
-
* @param includeMainPlatform Include main platform data
|
|
120
|
-
* @param startDate start date. ISO 8601
|
|
121
129
|
* @returns ActiveUsersPerCourse
|
|
122
130
|
* @throws ApiError
|
|
123
131
|
*/
|
|
124
|
-
static aiAnalyticsAudienceOrgsActiveUsersPerCourseRetrieve(org
|
|
132
|
+
static aiAnalyticsAudienceOrgsActiveUsersPerCourseRetrieve({ org, departmentId, endDate, format, includeMainPlatform, startDate, }: {
|
|
133
|
+
org: string;
|
|
134
|
+
/**
|
|
135
|
+
* When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
|
|
136
|
+
*/
|
|
137
|
+
departmentId?: number;
|
|
138
|
+
/**
|
|
139
|
+
* end date. ISO 8601
|
|
140
|
+
*/
|
|
141
|
+
endDate?: string;
|
|
142
|
+
/**
|
|
143
|
+
* Format
|
|
144
|
+
*
|
|
145
|
+
* * `json` - json
|
|
146
|
+
*/
|
|
147
|
+
format?: 'json';
|
|
148
|
+
/**
|
|
149
|
+
* Include main platform data
|
|
150
|
+
*/
|
|
151
|
+
includeMainPlatform?: boolean;
|
|
152
|
+
/**
|
|
153
|
+
* start date. ISO 8601
|
|
154
|
+
*/
|
|
155
|
+
startDate?: string;
|
|
156
|
+
}): CancelablePromise<ActiveUsersPerCourse>;
|
|
125
157
|
/**
|
|
126
158
|
* Get a list of active users with activity metrics.
|
|
127
159
|
*
|
|
@@ -139,18 +171,34 @@ export declare class AiAnalyticsService {
|
|
|
139
171
|
* A paginated list of active users with their activity metrics.
|
|
140
172
|
*
|
|
141
173
|
* Default time range is the last 7 days if no dates are specified.
|
|
142
|
-
* @param org
|
|
143
|
-
* @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
|
|
144
|
-
* @param format Format
|
|
145
|
-
*
|
|
146
|
-
* * `json` - json
|
|
147
|
-
* @param includeMainPlatform Include main platform data
|
|
148
|
-
* @param length Size of data to return
|
|
149
|
-
* @param page Page offset
|
|
150
174
|
* @returns ActiveUsersList
|
|
151
175
|
* @throws ApiError
|
|
152
176
|
*/
|
|
153
|
-
static aiAnalyticsAudienceOrgsActiveUsersUsersRetrieve(org
|
|
177
|
+
static aiAnalyticsAudienceOrgsActiveUsersUsersRetrieve({ org, departmentId, format, includeMainPlatform, length, page, }: {
|
|
178
|
+
org: string;
|
|
179
|
+
/**
|
|
180
|
+
* When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
|
|
181
|
+
*/
|
|
182
|
+
departmentId?: number;
|
|
183
|
+
/**
|
|
184
|
+
* Format
|
|
185
|
+
*
|
|
186
|
+
* * `json` - json
|
|
187
|
+
*/
|
|
188
|
+
format?: 'json';
|
|
189
|
+
/**
|
|
190
|
+
* Include main platform data
|
|
191
|
+
*/
|
|
192
|
+
includeMainPlatform?: boolean;
|
|
193
|
+
/**
|
|
194
|
+
* Size of data to return
|
|
195
|
+
*/
|
|
196
|
+
length?: number;
|
|
197
|
+
/**
|
|
198
|
+
* Page offset
|
|
199
|
+
*/
|
|
200
|
+
page?: number;
|
|
201
|
+
}): CancelablePromise<ActiveUsersList>;
|
|
154
202
|
/**
|
|
155
203
|
* Get enrollment or unenrollment counts over time.
|
|
156
204
|
*
|
|
@@ -168,29 +216,48 @@ export declare class AiAnalyticsService {
|
|
|
168
216
|
* compared to previous periods.
|
|
169
217
|
*
|
|
170
218
|
* Default time range is the last 7 days if no dates are specified.
|
|
171
|
-
* @param courseId
|
|
172
|
-
* @param org
|
|
173
|
-
* @param active Any of `y`, `yes`, `true`. set to false or no for unenrollments
|
|
174
|
-
*
|
|
175
|
-
* * `y` - y
|
|
176
|
-
* * `yes` - yes
|
|
177
|
-
* * `true` - true
|
|
178
|
-
* * `True` - True
|
|
179
|
-
* * `n` - n
|
|
180
|
-
* * `no` - no
|
|
181
|
-
* * `false` - false
|
|
182
|
-
* * `False` - False
|
|
183
|
-
* @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
|
|
184
|
-
* @param endDate end date. ISO 8601
|
|
185
|
-
* @param format Format
|
|
186
|
-
*
|
|
187
|
-
* * `json` - json
|
|
188
|
-
* @param includeMainPlatform Include main platform data
|
|
189
|
-
* @param startDate start date. ISO 8601
|
|
190
219
|
* @returns OvertimeWithChangeInfo
|
|
191
220
|
* @throws ApiError
|
|
192
221
|
*/
|
|
193
|
-
static aiAnalyticsAudienceOrgsEnrollmentsCoursesOverTimeRetrieve(courseId
|
|
222
|
+
static aiAnalyticsAudienceOrgsEnrollmentsCoursesOverTimeRetrieve({ courseId, org, active, departmentId, endDate, format, includeMainPlatform, startDate, }: {
|
|
223
|
+
courseId: string;
|
|
224
|
+
org: string;
|
|
225
|
+
/**
|
|
226
|
+
* Any of `y`, `yes`, `true`. set to false or no for unenrollments
|
|
227
|
+
*
|
|
228
|
+
* * `y` - y
|
|
229
|
+
* * `yes` - yes
|
|
230
|
+
* * `true` - true
|
|
231
|
+
* * `True` - True
|
|
232
|
+
* * `n` - n
|
|
233
|
+
* * `no` - no
|
|
234
|
+
* * `false` - false
|
|
235
|
+
* * `False` - False
|
|
236
|
+
*/
|
|
237
|
+
active?: 'y' | 'yes' | 'true' | 'True' | 'n' | 'no' | 'false' | 'False';
|
|
238
|
+
/**
|
|
239
|
+
* When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
|
|
240
|
+
*/
|
|
241
|
+
departmentId?: number;
|
|
242
|
+
/**
|
|
243
|
+
* end date. ISO 8601
|
|
244
|
+
*/
|
|
245
|
+
endDate?: string;
|
|
246
|
+
/**
|
|
247
|
+
* Format
|
|
248
|
+
*
|
|
249
|
+
* * `json` - json
|
|
250
|
+
*/
|
|
251
|
+
format?: 'json';
|
|
252
|
+
/**
|
|
253
|
+
* Include main platform data
|
|
254
|
+
*/
|
|
255
|
+
includeMainPlatform?: boolean;
|
|
256
|
+
/**
|
|
257
|
+
* start date. ISO 8601
|
|
258
|
+
*/
|
|
259
|
+
startDate?: string;
|
|
260
|
+
}): CancelablePromise<OvertimeWithChangeInfo>;
|
|
194
261
|
/**
|
|
195
262
|
* List users enrolled in a specific course.
|
|
196
263
|
*
|
|
@@ -209,31 +276,56 @@ export declare class AiAnalyticsService {
|
|
|
209
276
|
* - Full name
|
|
210
277
|
* - Email
|
|
211
278
|
* - Enrollment timestamp
|
|
212
|
-
* @param courseId
|
|
213
|
-
* @param org
|
|
214
|
-
* @param active Any of `y`, `yes`, `true`. set to false or no for unenrollments
|
|
215
|
-
*
|
|
216
|
-
* * `y` - y
|
|
217
|
-
* * `yes` - yes
|
|
218
|
-
* * `true` - true
|
|
219
|
-
* * `True` - True
|
|
220
|
-
* * `n` - n
|
|
221
|
-
* * `no` - no
|
|
222
|
-
* * `false` - false
|
|
223
|
-
* * `False` - False
|
|
224
|
-
* @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
|
|
225
|
-
* @param endDate end date. ISO 8601
|
|
226
|
-
* @param format Format
|
|
227
|
-
*
|
|
228
|
-
* * `json` - json
|
|
229
|
-
* @param includeMainPlatform Include main platform data
|
|
230
|
-
* @param length Size of data to return
|
|
231
|
-
* @param page Page offset
|
|
232
|
-
* @param startDate start date. ISO 8601
|
|
233
279
|
* @returns EnrollmentsPerUser
|
|
234
280
|
* @throws ApiError
|
|
235
281
|
*/
|
|
236
|
-
static aiAnalyticsAudienceOrgsEnrollmentsCoursesUsersRetrieve(courseId
|
|
282
|
+
static aiAnalyticsAudienceOrgsEnrollmentsCoursesUsersRetrieve({ courseId, org, active, departmentId, endDate, format, includeMainPlatform, length, page, startDate, }: {
|
|
283
|
+
courseId: string;
|
|
284
|
+
org: string;
|
|
285
|
+
/**
|
|
286
|
+
* Any of `y`, `yes`, `true`. set to false or no for unenrollments
|
|
287
|
+
*
|
|
288
|
+
* * `y` - y
|
|
289
|
+
* * `yes` - yes
|
|
290
|
+
* * `true` - true
|
|
291
|
+
* * `True` - True
|
|
292
|
+
* * `n` - n
|
|
293
|
+
* * `no` - no
|
|
294
|
+
* * `false` - false
|
|
295
|
+
* * `False` - False
|
|
296
|
+
*/
|
|
297
|
+
active?: 'y' | 'yes' | 'true' | 'True' | 'n' | 'no' | 'false' | 'False';
|
|
298
|
+
/**
|
|
299
|
+
* When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
|
|
300
|
+
*/
|
|
301
|
+
departmentId?: number;
|
|
302
|
+
/**
|
|
303
|
+
* end date. ISO 8601
|
|
304
|
+
*/
|
|
305
|
+
endDate?: string;
|
|
306
|
+
/**
|
|
307
|
+
* Format
|
|
308
|
+
*
|
|
309
|
+
* * `json` - json
|
|
310
|
+
*/
|
|
311
|
+
format?: 'json';
|
|
312
|
+
/**
|
|
313
|
+
* Include main platform data
|
|
314
|
+
*/
|
|
315
|
+
includeMainPlatform?: boolean;
|
|
316
|
+
/**
|
|
317
|
+
* Size of data to return
|
|
318
|
+
*/
|
|
319
|
+
length?: number;
|
|
320
|
+
/**
|
|
321
|
+
* Page offset
|
|
322
|
+
*/
|
|
323
|
+
page?: number;
|
|
324
|
+
/**
|
|
325
|
+
* start date. ISO 8601
|
|
326
|
+
*/
|
|
327
|
+
startDate?: string;
|
|
328
|
+
}): CancelablePromise<EnrollmentsPerUser>;
|
|
237
329
|
/**
|
|
238
330
|
* Get enrollment or unenrollment counts over time.
|
|
239
331
|
*
|
|
@@ -251,28 +343,47 @@ export declare class AiAnalyticsService {
|
|
|
251
343
|
* compared to previous periods.
|
|
252
344
|
*
|
|
253
345
|
* Default time range is the last 7 days if no dates are specified.
|
|
254
|
-
* @param org
|
|
255
|
-
* @param active Any of `y`, `yes`, `true`. set to false or no for unenrollments
|
|
256
|
-
*
|
|
257
|
-
* * `y` - y
|
|
258
|
-
* * `yes` - yes
|
|
259
|
-
* * `true` - true
|
|
260
|
-
* * `True` - True
|
|
261
|
-
* * `n` - n
|
|
262
|
-
* * `no` - no
|
|
263
|
-
* * `false` - false
|
|
264
|
-
* * `False` - False
|
|
265
|
-
* @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
|
|
266
|
-
* @param endDate end date. ISO 8601
|
|
267
|
-
* @param format Format
|
|
268
|
-
*
|
|
269
|
-
* * `json` - json
|
|
270
|
-
* @param includeMainPlatform Include main platform data
|
|
271
|
-
* @param startDate start date. ISO 8601
|
|
272
346
|
* @returns OvertimeWithChangeInfo
|
|
273
347
|
* @throws ApiError
|
|
274
348
|
*/
|
|
275
|
-
static aiAnalyticsAudienceOrgsEnrollmentsOverTimeRetrieve(org
|
|
349
|
+
static aiAnalyticsAudienceOrgsEnrollmentsOverTimeRetrieve({ org, active, departmentId, endDate, format, includeMainPlatform, startDate, }: {
|
|
350
|
+
org: string;
|
|
351
|
+
/**
|
|
352
|
+
* Any of `y`, `yes`, `true`. set to false or no for unenrollments
|
|
353
|
+
*
|
|
354
|
+
* * `y` - y
|
|
355
|
+
* * `yes` - yes
|
|
356
|
+
* * `true` - true
|
|
357
|
+
* * `True` - True
|
|
358
|
+
* * `n` - n
|
|
359
|
+
* * `no` - no
|
|
360
|
+
* * `false` - false
|
|
361
|
+
* * `False` - False
|
|
362
|
+
*/
|
|
363
|
+
active?: 'y' | 'yes' | 'true' | 'True' | 'n' | 'no' | 'false' | 'False';
|
|
364
|
+
/**
|
|
365
|
+
* When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
|
|
366
|
+
*/
|
|
367
|
+
departmentId?: number;
|
|
368
|
+
/**
|
|
369
|
+
* end date. ISO 8601
|
|
370
|
+
*/
|
|
371
|
+
endDate?: string;
|
|
372
|
+
/**
|
|
373
|
+
* Format
|
|
374
|
+
*
|
|
375
|
+
* * `json` - json
|
|
376
|
+
*/
|
|
377
|
+
format?: 'json';
|
|
378
|
+
/**
|
|
379
|
+
* Include main platform data
|
|
380
|
+
*/
|
|
381
|
+
includeMainPlatform?: boolean;
|
|
382
|
+
/**
|
|
383
|
+
* start date. ISO 8601
|
|
384
|
+
*/
|
|
385
|
+
startDate?: string;
|
|
386
|
+
}): CancelablePromise<OvertimeWithChangeInfo>;
|
|
276
387
|
/**
|
|
277
388
|
* List enrollment statistics on a per-course basis.
|
|
278
389
|
*
|
|
@@ -288,30 +399,55 @@ export declare class AiAnalyticsService {
|
|
|
288
399
|
*
|
|
289
400
|
* Returns:
|
|
290
401
|
* A paginated list of courses with their enrollment counts and percentages.
|
|
291
|
-
* @param org
|
|
292
|
-
* @param active Any of `y`, `yes`, `true`. set to false or no for unenrollments
|
|
293
|
-
*
|
|
294
|
-
* * `y` - y
|
|
295
|
-
* * `yes` - yes
|
|
296
|
-
* * `true` - true
|
|
297
|
-
* * `True` - True
|
|
298
|
-
* * `n` - n
|
|
299
|
-
* * `no` - no
|
|
300
|
-
* * `false` - false
|
|
301
|
-
* * `False` - False
|
|
302
|
-
* @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
|
|
303
|
-
* @param endDate end date. ISO 8601
|
|
304
|
-
* @param format Format
|
|
305
|
-
*
|
|
306
|
-
* * `json` - json
|
|
307
|
-
* @param includeMainPlatform Include main platform data
|
|
308
|
-
* @param length Size of data to return
|
|
309
|
-
* @param page Page offset
|
|
310
|
-
* @param startDate start date. ISO 8601
|
|
311
402
|
* @returns Enrollments
|
|
312
403
|
* @throws ApiError
|
|
313
404
|
*/
|
|
314
|
-
static aiAnalyticsAudienceOrgsEnrollmentsPerCourseRetrieve(org
|
|
405
|
+
static aiAnalyticsAudienceOrgsEnrollmentsPerCourseRetrieve({ org, active, departmentId, endDate, format, includeMainPlatform, length, page, startDate, }: {
|
|
406
|
+
org: string;
|
|
407
|
+
/**
|
|
408
|
+
* Any of `y`, `yes`, `true`. set to false or no for unenrollments
|
|
409
|
+
*
|
|
410
|
+
* * `y` - y
|
|
411
|
+
* * `yes` - yes
|
|
412
|
+
* * `true` - true
|
|
413
|
+
* * `True` - True
|
|
414
|
+
* * `n` - n
|
|
415
|
+
* * `no` - no
|
|
416
|
+
* * `false` - false
|
|
417
|
+
* * `False` - False
|
|
418
|
+
*/
|
|
419
|
+
active?: 'y' | 'yes' | 'true' | 'True' | 'n' | 'no' | 'false' | 'False';
|
|
420
|
+
/**
|
|
421
|
+
* When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
|
|
422
|
+
*/
|
|
423
|
+
departmentId?: number;
|
|
424
|
+
/**
|
|
425
|
+
* end date. ISO 8601
|
|
426
|
+
*/
|
|
427
|
+
endDate?: string;
|
|
428
|
+
/**
|
|
429
|
+
* Format
|
|
430
|
+
*
|
|
431
|
+
* * `json` - json
|
|
432
|
+
*/
|
|
433
|
+
format?: 'json';
|
|
434
|
+
/**
|
|
435
|
+
* Include main platform data
|
|
436
|
+
*/
|
|
437
|
+
includeMainPlatform?: boolean;
|
|
438
|
+
/**
|
|
439
|
+
* Size of data to return
|
|
440
|
+
*/
|
|
441
|
+
length?: number;
|
|
442
|
+
/**
|
|
443
|
+
* Page offset
|
|
444
|
+
*/
|
|
445
|
+
page?: number;
|
|
446
|
+
/**
|
|
447
|
+
* start date. ISO 8601
|
|
448
|
+
*/
|
|
449
|
+
startDate?: string;
|
|
450
|
+
}): CancelablePromise<Enrollments>;
|
|
315
451
|
/**
|
|
316
452
|
* List all learners on the platform with aggregated metrics.
|
|
317
453
|
*
|
|
@@ -327,19 +463,38 @@ export declare class AiAnalyticsService {
|
|
|
327
463
|
*
|
|
328
464
|
* Returns:
|
|
329
465
|
* A paginated list of learners with their associated metrics.
|
|
330
|
-
* @param org
|
|
331
|
-
* @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
|
|
332
|
-
* @param format Format
|
|
333
|
-
*
|
|
334
|
-
* * `json` - json
|
|
335
|
-
* @param includeMainPlatform Include main platform data
|
|
336
|
-
* @param length Size of data to return
|
|
337
|
-
* @param page Page offset
|
|
338
|
-
* @param search Search string for learner
|
|
339
466
|
* @returns PerlearnerUserList
|
|
340
467
|
* @throws ApiError
|
|
341
468
|
*/
|
|
342
|
-
static aiAnalyticsAudienceOrgsRegisteredUsersRetrieve(org
|
|
469
|
+
static aiAnalyticsAudienceOrgsRegisteredUsersRetrieve({ org, departmentId, format, includeMainPlatform, length, page, search, }: {
|
|
470
|
+
org: string;
|
|
471
|
+
/**
|
|
472
|
+
* When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
|
|
473
|
+
*/
|
|
474
|
+
departmentId?: number;
|
|
475
|
+
/**
|
|
476
|
+
* Format
|
|
477
|
+
*
|
|
478
|
+
* * `json` - json
|
|
479
|
+
*/
|
|
480
|
+
format?: 'json';
|
|
481
|
+
/**
|
|
482
|
+
* Include main platform data
|
|
483
|
+
*/
|
|
484
|
+
includeMainPlatform?: boolean;
|
|
485
|
+
/**
|
|
486
|
+
* Size of data to return
|
|
487
|
+
*/
|
|
488
|
+
length?: number;
|
|
489
|
+
/**
|
|
490
|
+
* Page offset
|
|
491
|
+
*/
|
|
492
|
+
page?: number;
|
|
493
|
+
/**
|
|
494
|
+
* Search string for learner
|
|
495
|
+
*/
|
|
496
|
+
search?: string;
|
|
497
|
+
}): CancelablePromise<PerlearnerUserList>;
|
|
343
498
|
/**
|
|
344
499
|
* Get registered user counts over time.
|
|
345
500
|
*
|
|
@@ -355,18 +510,34 @@ export declare class AiAnalyticsService {
|
|
|
355
510
|
* compared to previous periods.
|
|
356
511
|
*
|
|
357
512
|
* Default time range is the last 7 days if no dates are specified.
|
|
358
|
-
* @param org
|
|
359
|
-
* @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
|
|
360
|
-
* @param endDate end date. ISO 8601
|
|
361
|
-
* @param format Format
|
|
362
|
-
*
|
|
363
|
-
* * `json` - json
|
|
364
|
-
* @param includeMainPlatform Include main platform data
|
|
365
|
-
* @param startDate start date. ISO 8601
|
|
366
513
|
* @returns OvertimeWithChangeInfo
|
|
367
514
|
* @throws ApiError
|
|
368
515
|
*/
|
|
369
|
-
static aiAnalyticsAudienceOrgsRegisteredUsersOverTimeRetrieve(org
|
|
516
|
+
static aiAnalyticsAudienceOrgsRegisteredUsersOverTimeRetrieve({ org, departmentId, endDate, format, includeMainPlatform, startDate, }: {
|
|
517
|
+
org: string;
|
|
518
|
+
/**
|
|
519
|
+
* When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
|
|
520
|
+
*/
|
|
521
|
+
departmentId?: number;
|
|
522
|
+
/**
|
|
523
|
+
* end date. ISO 8601
|
|
524
|
+
*/
|
|
525
|
+
endDate?: string;
|
|
526
|
+
/**
|
|
527
|
+
* Format
|
|
528
|
+
*
|
|
529
|
+
* * `json` - json
|
|
530
|
+
*/
|
|
531
|
+
format?: 'json';
|
|
532
|
+
/**
|
|
533
|
+
* Include main platform data
|
|
534
|
+
*/
|
|
535
|
+
includeMainPlatform?: boolean;
|
|
536
|
+
/**
|
|
537
|
+
* start date. ISO 8601
|
|
538
|
+
*/
|
|
539
|
+
startDate?: string;
|
|
540
|
+
}): CancelablePromise<OvertimeWithChangeInfo>;
|
|
370
541
|
/**
|
|
371
542
|
* List enrollment statistics on a per-course basis.
|
|
372
543
|
*
|
|
@@ -382,38 +553,64 @@ export declare class AiAnalyticsService {
|
|
|
382
553
|
*
|
|
383
554
|
* Returns:
|
|
384
555
|
* A paginated list of courses with their enrollment counts and percentages.
|
|
385
|
-
* @param org
|
|
386
|
-
* @param active Any of `y`, `yes`, `true`. set to false or no for unenrollments
|
|
387
|
-
*
|
|
388
|
-
* * `y` - y
|
|
389
|
-
* * `yes` - yes
|
|
390
|
-
* * `true` - true
|
|
391
|
-
* * `True` - True
|
|
392
|
-
* * `n` - n
|
|
393
|
-
* * `no` - no
|
|
394
|
-
* * `false` - false
|
|
395
|
-
* * `False` - False
|
|
396
|
-
* @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
|
|
397
|
-
* @param endDate end date. ISO 8601
|
|
398
|
-
* @param format Format
|
|
399
|
-
*
|
|
400
|
-
* * `json` - json
|
|
401
|
-
* @param includeMainPlatform Include main platform data
|
|
402
|
-
* @param length Size of data to return
|
|
403
|
-
* @param page Page offset
|
|
404
|
-
* @param startDate start date. ISO 8601
|
|
405
556
|
* @returns Enrollments
|
|
406
557
|
* @throws ApiError
|
|
407
558
|
*/
|
|
408
|
-
static aiAnalyticsAudienceOrgsRegisteredUsersPerCourseRetrieve(org
|
|
559
|
+
static aiAnalyticsAudienceOrgsRegisteredUsersPerCourseRetrieve({ org, active, departmentId, endDate, format, includeMainPlatform, length, page, startDate, }: {
|
|
560
|
+
org: string;
|
|
561
|
+
/**
|
|
562
|
+
* Any of `y`, `yes`, `true`. set to false or no for unenrollments
|
|
563
|
+
*
|
|
564
|
+
* * `y` - y
|
|
565
|
+
* * `yes` - yes
|
|
566
|
+
* * `true` - true
|
|
567
|
+
* * `True` - True
|
|
568
|
+
* * `n` - n
|
|
569
|
+
* * `no` - no
|
|
570
|
+
* * `false` - false
|
|
571
|
+
* * `False` - False
|
|
572
|
+
*/
|
|
573
|
+
active?: 'y' | 'yes' | 'true' | 'True' | 'n' | 'no' | 'false' | 'False';
|
|
574
|
+
/**
|
|
575
|
+
* When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
|
|
576
|
+
*/
|
|
577
|
+
departmentId?: number;
|
|
578
|
+
/**
|
|
579
|
+
* end date. ISO 8601
|
|
580
|
+
*/
|
|
581
|
+
endDate?: string;
|
|
582
|
+
/**
|
|
583
|
+
* Format
|
|
584
|
+
*
|
|
585
|
+
* * `json` - json
|
|
586
|
+
*/
|
|
587
|
+
format?: 'json';
|
|
588
|
+
/**
|
|
589
|
+
* Include main platform data
|
|
590
|
+
*/
|
|
591
|
+
includeMainPlatform?: boolean;
|
|
592
|
+
/**
|
|
593
|
+
* Size of data to return
|
|
594
|
+
*/
|
|
595
|
+
length?: number;
|
|
596
|
+
/**
|
|
597
|
+
* Page offset
|
|
598
|
+
*/
|
|
599
|
+
page?: number;
|
|
600
|
+
/**
|
|
601
|
+
* start date. ISO 8601
|
|
602
|
+
*/
|
|
603
|
+
startDate?: string;
|
|
604
|
+
}): CancelablePromise<Enrollments>;
|
|
409
605
|
/**
|
|
410
606
|
* Retrieve paginated LLM usage costs aggregated by tenant.
|
|
411
|
-
* @param endDate
|
|
412
|
-
* @param startDate
|
|
413
607
|
* @returns CostPerTenant
|
|
414
608
|
* @throws ApiError
|
|
415
609
|
*/
|
|
416
|
-
static aiAnalyticsCostsPertenantList(endDate
|
|
610
|
+
static aiAnalyticsCostsPertenantList({ endDate, startDate, }: {
|
|
611
|
+
endDate: string;
|
|
612
|
+
startDate: string;
|
|
613
|
+
}): CancelablePromise<Array<CostPerTenant>>;
|
|
417
614
|
/**
|
|
418
615
|
* Get a list of departments with metrics and filtering options.
|
|
419
616
|
*
|
|
@@ -434,25 +631,62 @@ export declare class AiAnalyticsService {
|
|
|
434
631
|
*
|
|
435
632
|
* Returns:
|
|
436
633
|
* A paginated list of departments with comprehensive metrics.
|
|
437
|
-
* @param org
|
|
438
|
-
* @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
|
|
439
|
-
* @param departments Departments search string. Single string or list of strings. e.g 'sample_department' or `['department', 'another department']`
|
|
440
|
-
* @param endDate Filter by learners date_joined. Start date. ISO 8601
|
|
441
|
-
* @param format Format
|
|
442
|
-
*
|
|
443
|
-
* * `json` - json
|
|
444
|
-
* @param includeMainPlatform Include main platform data
|
|
445
|
-
* @param isEnrolled Filter for users who have at least an enro;lment
|
|
446
|
-
* @param length Size of data to return
|
|
447
|
-
* @param location Location search string
|
|
448
|
-
* @param page Page offset
|
|
449
|
-
* @param pathway Pathway string
|
|
450
|
-
* @param program Program search string
|
|
451
|
-
* @param startDate Filter by learners date_joined. Start date. ISO 8601
|
|
452
634
|
* @returns GroupList
|
|
453
635
|
* @throws ApiError
|
|
454
636
|
*/
|
|
455
|
-
static aiAnalyticsDepartmentsOrgsRetrieve(org
|
|
637
|
+
static aiAnalyticsDepartmentsOrgsRetrieve({ org, departmentId, departments, endDate, format, includeMainPlatform, isEnrolled, length, location, page, pathway, program, startDate, }: {
|
|
638
|
+
org: string;
|
|
639
|
+
/**
|
|
640
|
+
* When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
|
|
641
|
+
*/
|
|
642
|
+
departmentId?: number;
|
|
643
|
+
/**
|
|
644
|
+
* Departments search string. Single string or list of strings. e.g 'sample_department' or `['department', 'another department']`
|
|
645
|
+
*/
|
|
646
|
+
departments?: Array<string>;
|
|
647
|
+
/**
|
|
648
|
+
* Filter by learners date_joined. Start date. ISO 8601
|
|
649
|
+
*/
|
|
650
|
+
endDate?: string;
|
|
651
|
+
/**
|
|
652
|
+
* Format
|
|
653
|
+
*
|
|
654
|
+
* * `json` - json
|
|
655
|
+
*/
|
|
656
|
+
format?: 'json';
|
|
657
|
+
/**
|
|
658
|
+
* Include main platform data
|
|
659
|
+
*/
|
|
660
|
+
includeMainPlatform?: boolean;
|
|
661
|
+
/**
|
|
662
|
+
* Filter for users who have at least an enro;lment
|
|
663
|
+
*/
|
|
664
|
+
isEnrolled?: boolean | null;
|
|
665
|
+
/**
|
|
666
|
+
* Size of data to return
|
|
667
|
+
*/
|
|
668
|
+
length?: number;
|
|
669
|
+
/**
|
|
670
|
+
* Location search string
|
|
671
|
+
*/
|
|
672
|
+
location?: string;
|
|
673
|
+
/**
|
|
674
|
+
* Page offset
|
|
675
|
+
*/
|
|
676
|
+
page?: number;
|
|
677
|
+
/**
|
|
678
|
+
* Pathway string
|
|
679
|
+
*/
|
|
680
|
+
pathway?: string;
|
|
681
|
+
/**
|
|
682
|
+
* Program search string
|
|
683
|
+
*/
|
|
684
|
+
program?: string;
|
|
685
|
+
/**
|
|
686
|
+
* Filter by learners date_joined. Start date. ISO 8601
|
|
687
|
+
*/
|
|
688
|
+
startDate?: string;
|
|
689
|
+
}): CancelablePromise<GroupList>;
|
|
456
690
|
/**
|
|
457
691
|
* Get engagement metrics on a per-course basis.
|
|
458
692
|
*
|
|
@@ -465,18 +699,34 @@ export declare class AiAnalyticsService {
|
|
|
465
699
|
*
|
|
466
700
|
* Returns:
|
|
467
701
|
* A paginated list of courses with their engagement metrics.
|
|
468
|
-
* @param org
|
|
469
|
-
* @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
|
|
470
|
-
* @param format Format
|
|
471
|
-
*
|
|
472
|
-
* * `json` - json
|
|
473
|
-
* @param includeMainPlatform Include main platform data
|
|
474
|
-
* @param length Size of data to return
|
|
475
|
-
* @param page Page offset
|
|
476
702
|
* @returns EngagementPerCourse
|
|
477
703
|
* @throws ApiError
|
|
478
704
|
*/
|
|
479
|
-
static aiAnalyticsEngagementOrgsActivityRetrieve(org
|
|
705
|
+
static aiAnalyticsEngagementOrgsActivityRetrieve({ org, departmentId, format, includeMainPlatform, length, page, }: {
|
|
706
|
+
org: string;
|
|
707
|
+
/**
|
|
708
|
+
* When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
|
|
709
|
+
*/
|
|
710
|
+
departmentId?: number;
|
|
711
|
+
/**
|
|
712
|
+
* Format
|
|
713
|
+
*
|
|
714
|
+
* * `json` - json
|
|
715
|
+
*/
|
|
716
|
+
format?: 'json';
|
|
717
|
+
/**
|
|
718
|
+
* Include main platform data
|
|
719
|
+
*/
|
|
720
|
+
includeMainPlatform?: boolean;
|
|
721
|
+
/**
|
|
722
|
+
* Size of data to return
|
|
723
|
+
*/
|
|
724
|
+
length?: number;
|
|
725
|
+
/**
|
|
726
|
+
* Page offset
|
|
727
|
+
*/
|
|
728
|
+
page?: number;
|
|
729
|
+
}): CancelablePromise<EngagementPerCourse>;
|
|
480
730
|
/**
|
|
481
731
|
* Completion count per user per course across the platform
|
|
482
732
|
*
|
|
@@ -485,18 +735,34 @@ export declare class AiAnalyticsService {
|
|
|
485
735
|
* 2. end_date e.g 2020-10-10
|
|
486
736
|
*
|
|
487
737
|
* Default result when no query param is added is last_7_days (today inclusive)
|
|
488
|
-
* @param org
|
|
489
|
-
* @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
|
|
490
|
-
* @param endDate end date. ISO 8601
|
|
491
|
-
* @param format Format
|
|
492
|
-
*
|
|
493
|
-
* * `json` - json
|
|
494
|
-
* @param includeMainPlatform Include main platform data
|
|
495
|
-
* @param startDate start date. ISO 8601
|
|
496
738
|
* @returns OvertimeWithChangeInfo
|
|
497
739
|
* @throws ApiError
|
|
498
740
|
*/
|
|
499
|
-
static aiAnalyticsEngagementOrgsCourseCompletionOverTimeRetrieve(org
|
|
741
|
+
static aiAnalyticsEngagementOrgsCourseCompletionOverTimeRetrieve({ org, departmentId, endDate, format, includeMainPlatform, startDate, }: {
|
|
742
|
+
org: string;
|
|
743
|
+
/**
|
|
744
|
+
* When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
|
|
745
|
+
*/
|
|
746
|
+
departmentId?: number;
|
|
747
|
+
/**
|
|
748
|
+
* end date. ISO 8601
|
|
749
|
+
*/
|
|
750
|
+
endDate?: string;
|
|
751
|
+
/**
|
|
752
|
+
* Format
|
|
753
|
+
*
|
|
754
|
+
* * `json` - json
|
|
755
|
+
*/
|
|
756
|
+
format?: 'json';
|
|
757
|
+
/**
|
|
758
|
+
* Include main platform data
|
|
759
|
+
*/
|
|
760
|
+
includeMainPlatform?: boolean;
|
|
761
|
+
/**
|
|
762
|
+
* start date. ISO 8601
|
|
763
|
+
*/
|
|
764
|
+
startDate?: string;
|
|
765
|
+
}): CancelablePromise<OvertimeWithChangeInfo>;
|
|
500
766
|
/**
|
|
501
767
|
* List course completion metrics on a per-course basis.
|
|
502
768
|
*
|
|
@@ -509,18 +775,34 @@ export declare class AiAnalyticsService {
|
|
|
509
775
|
* - Enrollment count
|
|
510
776
|
* - Completion count
|
|
511
777
|
* - Average completion rate
|
|
512
|
-
* @param org
|
|
513
|
-
* @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
|
|
514
|
-
* @param format Format
|
|
515
|
-
*
|
|
516
|
-
* * `json` - json
|
|
517
|
-
* @param includeMainPlatform Include main platform data
|
|
518
|
-
* @param length Size of data to return
|
|
519
|
-
* @param page Page offset
|
|
520
778
|
* @returns CourseCompletionPerCourse
|
|
521
779
|
* @throws ApiError
|
|
522
780
|
*/
|
|
523
|
-
static aiAnalyticsEngagementOrgsCourseCompletionPerCourseRetrieve(org
|
|
781
|
+
static aiAnalyticsEngagementOrgsCourseCompletionPerCourseRetrieve({ org, departmentId, format, includeMainPlatform, length, page, }: {
|
|
782
|
+
org: string;
|
|
783
|
+
/**
|
|
784
|
+
* When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
|
|
785
|
+
*/
|
|
786
|
+
departmentId?: number;
|
|
787
|
+
/**
|
|
788
|
+
* Format
|
|
789
|
+
*
|
|
790
|
+
* * `json` - json
|
|
791
|
+
*/
|
|
792
|
+
format?: 'json';
|
|
793
|
+
/**
|
|
794
|
+
* Include main platform data
|
|
795
|
+
*/
|
|
796
|
+
includeMainPlatform?: boolean;
|
|
797
|
+
/**
|
|
798
|
+
* Size of data to return
|
|
799
|
+
*/
|
|
800
|
+
length?: number;
|
|
801
|
+
/**
|
|
802
|
+
* Page offset
|
|
803
|
+
*/
|
|
804
|
+
page?: number;
|
|
805
|
+
}): CancelablePromise<CourseCompletionPerCourse>;
|
|
524
806
|
/**
|
|
525
807
|
* Average time spent in secs on a per-day basis
|
|
526
808
|
*
|
|
@@ -530,19 +812,35 @@ export declare class AiAnalyticsService {
|
|
|
530
812
|
* 3. course_id <optional>
|
|
531
813
|
*
|
|
532
814
|
* Default result when no query param is added is last_7_days (today inclusive)
|
|
533
|
-
* @param courseId
|
|
534
|
-
* @param org
|
|
535
|
-
* @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
|
|
536
|
-
* @param endDate end date. ISO 8601
|
|
537
|
-
* @param format Format
|
|
538
|
-
*
|
|
539
|
-
* * `json` - json
|
|
540
|
-
* @param includeMainPlatform Include main platform data
|
|
541
|
-
* @param startDate start date. ISO 8601
|
|
542
815
|
* @returns AverageOvertime
|
|
543
816
|
* @throws ApiError
|
|
544
817
|
*/
|
|
545
|
-
static aiAnalyticsEngagementOrgsCoursesTimeAverageRetrieve(courseId
|
|
818
|
+
static aiAnalyticsEngagementOrgsCoursesTimeAverageRetrieve({ courseId, org, departmentId, endDate, format, includeMainPlatform, startDate, }: {
|
|
819
|
+
courseId: string;
|
|
820
|
+
org: string;
|
|
821
|
+
/**
|
|
822
|
+
* When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
|
|
823
|
+
*/
|
|
824
|
+
departmentId?: number;
|
|
825
|
+
/**
|
|
826
|
+
* end date. ISO 8601
|
|
827
|
+
*/
|
|
828
|
+
endDate?: string;
|
|
829
|
+
/**
|
|
830
|
+
* Format
|
|
831
|
+
*
|
|
832
|
+
* * `json` - json
|
|
833
|
+
*/
|
|
834
|
+
format?: 'json';
|
|
835
|
+
/**
|
|
836
|
+
* Include main platform data
|
|
837
|
+
*/
|
|
838
|
+
includeMainPlatform?: boolean;
|
|
839
|
+
/**
|
|
840
|
+
* start date. ISO 8601
|
|
841
|
+
*/
|
|
842
|
+
startDate?: string;
|
|
843
|
+
}): CancelablePromise<AverageOvertime>;
|
|
546
844
|
/**
|
|
547
845
|
* Time spent per course in secs in a tree like form
|
|
548
846
|
*
|
|
@@ -552,17 +850,27 @@ export declare class AiAnalyticsService {
|
|
|
552
850
|
* Query Params
|
|
553
851
|
* 1. start_date <optional> e.g 2020-10-01
|
|
554
852
|
* 2. end_date <optional> e.g 2020-10-10
|
|
555
|
-
* @param courseId
|
|
556
|
-
* @param org
|
|
557
|
-
* @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
|
|
558
|
-
* @param format Format
|
|
559
|
-
*
|
|
560
|
-
* * `json` - json
|
|
561
|
-
* @param includeMainPlatform Include main platform data
|
|
562
853
|
* @returns TimeDetail
|
|
563
854
|
* @throws ApiError
|
|
564
855
|
*/
|
|
565
|
-
static aiAnalyticsEngagementOrgsCoursesTimeDetailRetrieve(courseId
|
|
856
|
+
static aiAnalyticsEngagementOrgsCoursesTimeDetailRetrieve({ courseId, org, departmentId, format, includeMainPlatform, }: {
|
|
857
|
+
courseId: string;
|
|
858
|
+
org: string;
|
|
859
|
+
/**
|
|
860
|
+
* When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
|
|
861
|
+
*/
|
|
862
|
+
departmentId?: number;
|
|
863
|
+
/**
|
|
864
|
+
* Format
|
|
865
|
+
*
|
|
866
|
+
* * `json` - json
|
|
867
|
+
*/
|
|
868
|
+
format?: 'json';
|
|
869
|
+
/**
|
|
870
|
+
* Include main platform data
|
|
871
|
+
*/
|
|
872
|
+
includeMainPlatform?: boolean;
|
|
873
|
+
}): CancelablePromise<TimeDetail>;
|
|
566
874
|
/**
|
|
567
875
|
* Time spent per course in secs on a per-day basis
|
|
568
876
|
*
|
|
@@ -573,39 +881,77 @@ export declare class AiAnalyticsService {
|
|
|
573
881
|
* 3. course_id
|
|
574
882
|
*
|
|
575
883
|
* Default result when no query param is added is last_7_days (today inclusive)
|
|
576
|
-
* @param courseId
|
|
577
|
-
* @param org
|
|
578
|
-
* @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
|
|
579
|
-
* @param endDate end date. ISO 8601
|
|
580
|
-
* @param format Format
|
|
581
|
-
*
|
|
582
|
-
* * `json` - json
|
|
583
|
-
* @param includeMainPlatform Include main platform data
|
|
584
|
-
* @param startDate start date. ISO 8601
|
|
585
884
|
* @returns OverTimeWithTotal
|
|
586
885
|
* @throws ApiError
|
|
587
886
|
*/
|
|
588
|
-
static aiAnalyticsEngagementOrgsCoursesTimeOverTimeRetrieve(courseId
|
|
887
|
+
static aiAnalyticsEngagementOrgsCoursesTimeOverTimeRetrieve({ courseId, org, departmentId, endDate, format, includeMainPlatform, startDate, }: {
|
|
888
|
+
courseId: string;
|
|
889
|
+
org: string;
|
|
890
|
+
/**
|
|
891
|
+
* When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
|
|
892
|
+
*/
|
|
893
|
+
departmentId?: number;
|
|
894
|
+
/**
|
|
895
|
+
* end date. ISO 8601
|
|
896
|
+
*/
|
|
897
|
+
endDate?: string;
|
|
898
|
+
/**
|
|
899
|
+
* Format
|
|
900
|
+
*
|
|
901
|
+
* * `json` - json
|
|
902
|
+
*/
|
|
903
|
+
format?: 'json';
|
|
904
|
+
/**
|
|
905
|
+
* Include main platform data
|
|
906
|
+
*/
|
|
907
|
+
includeMainPlatform?: boolean;
|
|
908
|
+
/**
|
|
909
|
+
* start date. ISO 8601
|
|
910
|
+
*/
|
|
911
|
+
startDate?: string;
|
|
912
|
+
}): CancelablePromise<OverTimeWithTotal>;
|
|
589
913
|
/**
|
|
590
914
|
* Time spent by users in a course
|
|
591
915
|
*
|
|
592
916
|
* Query Params
|
|
593
917
|
* course_id e.g course-v1:Org+Course4+Run
|
|
594
|
-
* @param courseId
|
|
595
|
-
* @param org
|
|
596
|
-
* @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
|
|
597
|
-
* @param endDate end date. ISO 8601
|
|
598
|
-
* @param format Format
|
|
599
|
-
*
|
|
600
|
-
* * `json` - json
|
|
601
|
-
* @param includeMainPlatform Include main platform data
|
|
602
|
-
* @param length Size of data to return
|
|
603
|
-
* @param page Page offset
|
|
604
|
-
* @param startDate start date. ISO 8601
|
|
605
918
|
* @returns TimeSpentByUsersInCourse
|
|
606
919
|
* @throws ApiError
|
|
607
920
|
*/
|
|
608
|
-
static aiAnalyticsEngagementOrgsCoursesTimeUsersRetrieve(courseId
|
|
921
|
+
static aiAnalyticsEngagementOrgsCoursesTimeUsersRetrieve({ courseId, org, departmentId, endDate, format, includeMainPlatform, length, page, startDate, }: {
|
|
922
|
+
courseId: string;
|
|
923
|
+
org: string;
|
|
924
|
+
/**
|
|
925
|
+
* When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
|
|
926
|
+
*/
|
|
927
|
+
departmentId?: number;
|
|
928
|
+
/**
|
|
929
|
+
* end date. ISO 8601
|
|
930
|
+
*/
|
|
931
|
+
endDate?: string;
|
|
932
|
+
/**
|
|
933
|
+
* Format
|
|
934
|
+
*
|
|
935
|
+
* * `json` - json
|
|
936
|
+
*/
|
|
937
|
+
format?: 'json';
|
|
938
|
+
/**
|
|
939
|
+
* Include main platform data
|
|
940
|
+
*/
|
|
941
|
+
includeMainPlatform?: boolean;
|
|
942
|
+
/**
|
|
943
|
+
* Size of data to return
|
|
944
|
+
*/
|
|
945
|
+
length?: number;
|
|
946
|
+
/**
|
|
947
|
+
* Page offset
|
|
948
|
+
*/
|
|
949
|
+
page?: number;
|
|
950
|
+
/**
|
|
951
|
+
* start date. ISO 8601
|
|
952
|
+
*/
|
|
953
|
+
startDate?: string;
|
|
954
|
+
}): CancelablePromise<TimeSpentByUsersInCourse>;
|
|
609
955
|
/**
|
|
610
956
|
* Time spent within a course in ordered hierarchical format
|
|
611
957
|
*
|
|
@@ -615,20 +961,30 @@ export declare class AiAnalyticsService {
|
|
|
615
961
|
* Query Params
|
|
616
962
|
* 3. start_date <optional> e.g 2020-10-01
|
|
617
963
|
* 4. end_date <optional> e.g 2020-10-10
|
|
618
|
-
* @param courseId
|
|
619
|
-
* @param org
|
|
620
|
-
* @param userId
|
|
621
|
-
* @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
|
|
622
|
-
* @param endDate end date. ISO 8601
|
|
623
|
-
* @param format Format
|
|
624
|
-
*
|
|
625
|
-
* * `json` - json
|
|
626
|
-
* @param includeMainPlatform Include main platform data
|
|
627
|
-
* @param startDate start date. ISO 8601
|
|
628
964
|
* @returns PerLearnerTimeSpentInCourseTree
|
|
629
965
|
* @throws ApiError
|
|
630
966
|
*/
|
|
631
|
-
static aiAnalyticsEngagementOrgsCoursesTimeUsersDetailRetrieve(courseId
|
|
967
|
+
static aiAnalyticsEngagementOrgsCoursesTimeUsersDetailRetrieve({ courseId, org, userId, departmentId, endDate, format, includeMainPlatform, startDate, }: {
|
|
968
|
+
courseId: string;
|
|
969
|
+
org: string; /**
|
|
970
|
+
* When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
|
|
971
|
+
*/
|
|
972
|
+
departmentId?: number; /**
|
|
973
|
+
* end date. ISO 8601
|
|
974
|
+
*/
|
|
975
|
+
endDate?: string; /**
|
|
976
|
+
* Format
|
|
977
|
+
*
|
|
978
|
+
* * `json` - json
|
|
979
|
+
*/
|
|
980
|
+
format?: 'json'; /**
|
|
981
|
+
* Include main platform data
|
|
982
|
+
*/
|
|
983
|
+
includeMainPlatform?: boolean; /**
|
|
984
|
+
* start date. ISO 8601
|
|
985
|
+
*/
|
|
986
|
+
startDate?: string;
|
|
987
|
+
}): CancelablePromise<PerLearnerTimeSpentInCourseTree>;
|
|
632
988
|
/**
|
|
633
989
|
* Time spent in secs on a per-day basis
|
|
634
990
|
*
|
|
@@ -639,20 +995,30 @@ export declare class AiAnalyticsService {
|
|
|
639
995
|
* 4. end_date e.g 2020-10-10
|
|
640
996
|
*
|
|
641
997
|
* Default result when no query param is added is last_7_days (today inclusive)
|
|
642
|
-
* @param courseId
|
|
643
|
-
* @param org
|
|
644
|
-
* @param userId
|
|
645
|
-
* @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
|
|
646
|
-
* @param endDate end date. ISO 8601
|
|
647
|
-
* @param format Format
|
|
648
|
-
*
|
|
649
|
-
* * `json` - json
|
|
650
|
-
* @param includeMainPlatform Include main platform data
|
|
651
|
-
* @param startDate start date. ISO 8601
|
|
652
998
|
* @returns OverTimeWithTotal
|
|
653
999
|
* @throws ApiError
|
|
654
1000
|
*/
|
|
655
|
-
static aiAnalyticsEngagementOrgsCoursesTimeUsersOverTimeRetrieve(courseId
|
|
1001
|
+
static aiAnalyticsEngagementOrgsCoursesTimeUsersOverTimeRetrieve({ courseId, org, userId, departmentId, endDate, format, includeMainPlatform, startDate, }: {
|
|
1002
|
+
courseId: string;
|
|
1003
|
+
org: string; /**
|
|
1004
|
+
* When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
|
|
1005
|
+
*/
|
|
1006
|
+
departmentId?: number; /**
|
|
1007
|
+
* end date. ISO 8601
|
|
1008
|
+
*/
|
|
1009
|
+
endDate?: string; /**
|
|
1010
|
+
* Format
|
|
1011
|
+
*
|
|
1012
|
+
* * `json` - json
|
|
1013
|
+
*/
|
|
1014
|
+
format?: 'json'; /**
|
|
1015
|
+
* Include main platform data
|
|
1016
|
+
*/
|
|
1017
|
+
includeMainPlatform?: boolean; /**
|
|
1018
|
+
* start date. ISO 8601
|
|
1019
|
+
*/
|
|
1020
|
+
startDate?: string;
|
|
1021
|
+
}): CancelablePromise<OverTimeWithTotal>;
|
|
656
1022
|
/**
|
|
657
1023
|
* Get video engagement metrics for a specific course.
|
|
658
1024
|
*
|
|
@@ -664,17 +1030,27 @@ export declare class AiAnalyticsService {
|
|
|
664
1030
|
*
|
|
665
1031
|
* Returns:
|
|
666
1032
|
* Detailed video engagement metrics for the specified course.
|
|
667
|
-
* @param courseId
|
|
668
|
-
* @param org
|
|
669
|
-
* @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
|
|
670
|
-
* @param format Format
|
|
671
|
-
*
|
|
672
|
-
* * `json` - json
|
|
673
|
-
* @param includeMainPlatform Include main platform data
|
|
674
1033
|
* @returns VideosSpecificCourse
|
|
675
1034
|
* @throws ApiError
|
|
676
1035
|
*/
|
|
677
|
-
static aiAnalyticsEngagementOrgsCoursesVideosRetrieve(courseId
|
|
1036
|
+
static aiAnalyticsEngagementOrgsCoursesVideosRetrieve({ courseId, org, departmentId, format, includeMainPlatform, }: {
|
|
1037
|
+
courseId: string;
|
|
1038
|
+
org: string;
|
|
1039
|
+
/**
|
|
1040
|
+
* When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
|
|
1041
|
+
*/
|
|
1042
|
+
departmentId?: number;
|
|
1043
|
+
/**
|
|
1044
|
+
* Format
|
|
1045
|
+
*
|
|
1046
|
+
* * `json` - json
|
|
1047
|
+
*/
|
|
1048
|
+
format?: 'json';
|
|
1049
|
+
/**
|
|
1050
|
+
* Include main platform data
|
|
1051
|
+
*/
|
|
1052
|
+
includeMainPlatform?: boolean;
|
|
1053
|
+
}): CancelablePromise<VideosSpecificCourse>;
|
|
678
1054
|
/**
|
|
679
1055
|
* Get video watch counts over time.
|
|
680
1056
|
*
|
|
@@ -695,19 +1071,35 @@ export declare class AiAnalyticsService {
|
|
|
695
1071
|
* Access Control:
|
|
696
1072
|
* - Platform admins can access any video watch data
|
|
697
1073
|
* - Learners can access their own video watch data
|
|
698
|
-
* @param courseId
|
|
699
|
-
* @param org
|
|
700
|
-
* @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
|
|
701
|
-
* @param endDate end date. ISO 8601
|
|
702
|
-
* @param format Format
|
|
703
|
-
*
|
|
704
|
-
* * `json` - json
|
|
705
|
-
* @param includeMainPlatform Include main platform data
|
|
706
|
-
* @param startDate start date. ISO 8601
|
|
707
1074
|
* @returns OverTimeWithTotal
|
|
708
1075
|
* @throws ApiError
|
|
709
1076
|
*/
|
|
710
|
-
static aiAnalyticsEngagementOrgsCoursesVideosOverTimeRetrieve(courseId
|
|
1077
|
+
static aiAnalyticsEngagementOrgsCoursesVideosOverTimeRetrieve({ courseId, org, departmentId, endDate, format, includeMainPlatform, startDate, }: {
|
|
1078
|
+
courseId: string;
|
|
1079
|
+
org: string;
|
|
1080
|
+
/**
|
|
1081
|
+
* When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
|
|
1082
|
+
*/
|
|
1083
|
+
departmentId?: number;
|
|
1084
|
+
/**
|
|
1085
|
+
* end date. ISO 8601
|
|
1086
|
+
*/
|
|
1087
|
+
endDate?: string;
|
|
1088
|
+
/**
|
|
1089
|
+
* Format
|
|
1090
|
+
*
|
|
1091
|
+
* * `json` - json
|
|
1092
|
+
*/
|
|
1093
|
+
format?: 'json';
|
|
1094
|
+
/**
|
|
1095
|
+
* Include main platform data
|
|
1096
|
+
*/
|
|
1097
|
+
includeMainPlatform?: boolean;
|
|
1098
|
+
/**
|
|
1099
|
+
* start date. ISO 8601
|
|
1100
|
+
*/
|
|
1101
|
+
startDate?: string;
|
|
1102
|
+
}): CancelablePromise<OverTimeWithTotal>;
|
|
711
1103
|
/**
|
|
712
1104
|
* Get a summary of video watch statistics for a specific course.
|
|
713
1105
|
*
|
|
@@ -722,33 +1114,53 @@ export declare class AiAnalyticsService {
|
|
|
722
1114
|
* - Section and subsection organization
|
|
723
1115
|
* - Video identification and metadata
|
|
724
1116
|
* - Watch counts and completion rates
|
|
725
|
-
* @param courseId
|
|
726
|
-
* @param org
|
|
727
|
-
* @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
|
|
728
|
-
* @param format Format
|
|
729
|
-
*
|
|
730
|
-
* * `json` - json
|
|
731
|
-
* @param includeMainPlatform Include main platform data
|
|
732
1117
|
* @returns VideosInCourseSummary
|
|
733
1118
|
* @throws ApiError
|
|
734
1119
|
*/
|
|
735
|
-
static aiAnalyticsEngagementOrgsCoursesVideosSummaryRetrieve(courseId
|
|
1120
|
+
static aiAnalyticsEngagementOrgsCoursesVideosSummaryRetrieve({ courseId, org, departmentId, format, includeMainPlatform, }: {
|
|
1121
|
+
courseId: string;
|
|
1122
|
+
org: string;
|
|
1123
|
+
/**
|
|
1124
|
+
* When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
|
|
1125
|
+
*/
|
|
1126
|
+
departmentId?: number;
|
|
1127
|
+
/**
|
|
1128
|
+
* Format
|
|
1129
|
+
*
|
|
1130
|
+
* * `json` - json
|
|
1131
|
+
*/
|
|
1132
|
+
format?: 'json';
|
|
1133
|
+
/**
|
|
1134
|
+
* Include main platform data
|
|
1135
|
+
*/
|
|
1136
|
+
includeMainPlatform?: boolean;
|
|
1137
|
+
}): CancelablePromise<VideosInCourseSummary>;
|
|
736
1138
|
/**
|
|
737
1139
|
* List of users' videos completed records for a specific course
|
|
738
1140
|
*
|
|
739
1141
|
* Kwargs
|
|
740
1142
|
* course_id e.g course-v1:Org+Course4+Run
|
|
741
|
-
* @param courseId
|
|
742
|
-
* @param org
|
|
743
|
-
* @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
|
|
744
|
-
* @param format Format
|
|
745
|
-
*
|
|
746
|
-
* * `json` - json
|
|
747
|
-
* @param includeMainPlatform Include main platform data
|
|
748
1143
|
* @returns WatchedVideosPerUser
|
|
749
1144
|
* @throws ApiError
|
|
750
1145
|
*/
|
|
751
|
-
static aiAnalyticsEngagementOrgsCoursesVideosUsersRetrieve(courseId
|
|
1146
|
+
static aiAnalyticsEngagementOrgsCoursesVideosUsersRetrieve({ courseId, org, departmentId, format, includeMainPlatform, }: {
|
|
1147
|
+
courseId: string;
|
|
1148
|
+
org: string;
|
|
1149
|
+
/**
|
|
1150
|
+
* When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
|
|
1151
|
+
*/
|
|
1152
|
+
departmentId?: number;
|
|
1153
|
+
/**
|
|
1154
|
+
* Format
|
|
1155
|
+
*
|
|
1156
|
+
* * `json` - json
|
|
1157
|
+
*/
|
|
1158
|
+
format?: 'json';
|
|
1159
|
+
/**
|
|
1160
|
+
* Include main platform data
|
|
1161
|
+
*/
|
|
1162
|
+
includeMainPlatform?: boolean;
|
|
1163
|
+
}): CancelablePromise<WatchedVideosPerUser>;
|
|
752
1164
|
/**
|
|
753
1165
|
* Average time spent by a learner in enrolled courses. Gives a rough estimate of whats the average time
|
|
754
1166
|
* that would be spent by a learner in a course
|
|
@@ -756,18 +1168,34 @@ export declare class AiAnalyticsService {
|
|
|
756
1168
|
* Query Params
|
|
757
1169
|
* 1. start_date e.g 2020-10-01
|
|
758
1170
|
* 2. end_date e.g 2020-10-10
|
|
759
|
-
* @param org
|
|
760
|
-
* @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
|
|
761
|
-
* @param endDate end date. ISO 8601
|
|
762
|
-
* @param format Format
|
|
763
|
-
*
|
|
764
|
-
* * `json` - json
|
|
765
|
-
* @param includeMainPlatform Include main platform data
|
|
766
|
-
* @param startDate start date. ISO 8601
|
|
767
1171
|
* @returns AverageOvertime
|
|
768
1172
|
* @throws ApiError
|
|
769
1173
|
*/
|
|
770
|
-
static aiAnalyticsEngagementOrgsTimeAveragePerlearnerPercourseRetrieve(org
|
|
1174
|
+
static aiAnalyticsEngagementOrgsTimeAveragePerlearnerPercourseRetrieve({ org, departmentId, endDate, format, includeMainPlatform, startDate, }: {
|
|
1175
|
+
org: string;
|
|
1176
|
+
/**
|
|
1177
|
+
* When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
|
|
1178
|
+
*/
|
|
1179
|
+
departmentId?: number;
|
|
1180
|
+
/**
|
|
1181
|
+
* end date. ISO 8601
|
|
1182
|
+
*/
|
|
1183
|
+
endDate?: string;
|
|
1184
|
+
/**
|
|
1185
|
+
* Format
|
|
1186
|
+
*
|
|
1187
|
+
* * `json` - json
|
|
1188
|
+
*/
|
|
1189
|
+
format?: 'json';
|
|
1190
|
+
/**
|
|
1191
|
+
* Include main platform data
|
|
1192
|
+
*/
|
|
1193
|
+
includeMainPlatform?: boolean;
|
|
1194
|
+
/**
|
|
1195
|
+
* start date. ISO 8601
|
|
1196
|
+
*/
|
|
1197
|
+
startDate?: string;
|
|
1198
|
+
}): CancelablePromise<AverageOvertime>;
|
|
771
1199
|
/**
|
|
772
1200
|
* Average time spent in secs on a per-day basis
|
|
773
1201
|
*
|
|
@@ -777,18 +1205,34 @@ export declare class AiAnalyticsService {
|
|
|
777
1205
|
* 3. course_id <optional>
|
|
778
1206
|
*
|
|
779
1207
|
* Default result when no query param is added is last_7_days (today inclusive)
|
|
780
|
-
* @param org
|
|
781
|
-
* @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
|
|
782
|
-
* @param endDate end date. ISO 8601
|
|
783
|
-
* @param format Format
|
|
784
|
-
*
|
|
785
|
-
* * `json` - json
|
|
786
|
-
* @param includeMainPlatform Include main platform data
|
|
787
|
-
* @param startDate start date. ISO 8601
|
|
788
1208
|
* @returns AverageOvertime
|
|
789
1209
|
* @throws ApiError
|
|
790
1210
|
*/
|
|
791
|
-
static aiAnalyticsEngagementOrgsTimeAverageWithOverTimeRetrieve(org
|
|
1211
|
+
static aiAnalyticsEngagementOrgsTimeAverageWithOverTimeRetrieve({ org, departmentId, endDate, format, includeMainPlatform, startDate, }: {
|
|
1212
|
+
org: string;
|
|
1213
|
+
/**
|
|
1214
|
+
* When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
|
|
1215
|
+
*/
|
|
1216
|
+
departmentId?: number;
|
|
1217
|
+
/**
|
|
1218
|
+
* end date. ISO 8601
|
|
1219
|
+
*/
|
|
1220
|
+
endDate?: string;
|
|
1221
|
+
/**
|
|
1222
|
+
* Format
|
|
1223
|
+
*
|
|
1224
|
+
* * `json` - json
|
|
1225
|
+
*/
|
|
1226
|
+
format?: 'json';
|
|
1227
|
+
/**
|
|
1228
|
+
* Include main platform data
|
|
1229
|
+
*/
|
|
1230
|
+
includeMainPlatform?: boolean;
|
|
1231
|
+
/**
|
|
1232
|
+
* start date. ISO 8601
|
|
1233
|
+
*/
|
|
1234
|
+
startDate?: string;
|
|
1235
|
+
}): CancelablePromise<AverageOvertime>;
|
|
792
1236
|
/**
|
|
793
1237
|
* Get time spent on the platform over time.
|
|
794
1238
|
*
|
|
@@ -804,18 +1248,34 @@ export declare class AiAnalyticsService {
|
|
|
804
1248
|
* compared to previous periods.
|
|
805
1249
|
*
|
|
806
1250
|
* Default time range is the last 7 days if no dates are specified.
|
|
807
|
-
* @param org
|
|
808
|
-
* @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
|
|
809
|
-
* @param endDate end date. ISO 8601
|
|
810
|
-
* @param format Format
|
|
811
|
-
*
|
|
812
|
-
* * `json` - json
|
|
813
|
-
* @param includeMainPlatform Include main platform data
|
|
814
|
-
* @param startDate start date. ISO 8601
|
|
815
1251
|
* @returns OvertimeWithChangeInfo
|
|
816
1252
|
* @throws ApiError
|
|
817
1253
|
*/
|
|
818
|
-
static aiAnalyticsEngagementOrgsTimeOverTimeRetrieve(org
|
|
1254
|
+
static aiAnalyticsEngagementOrgsTimeOverTimeRetrieve({ org, departmentId, endDate, format, includeMainPlatform, startDate, }: {
|
|
1255
|
+
org: string;
|
|
1256
|
+
/**
|
|
1257
|
+
* When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
|
|
1258
|
+
*/
|
|
1259
|
+
departmentId?: number;
|
|
1260
|
+
/**
|
|
1261
|
+
* end date. ISO 8601
|
|
1262
|
+
*/
|
|
1263
|
+
endDate?: string;
|
|
1264
|
+
/**
|
|
1265
|
+
* Format
|
|
1266
|
+
*
|
|
1267
|
+
* * `json` - json
|
|
1268
|
+
*/
|
|
1269
|
+
format?: 'json';
|
|
1270
|
+
/**
|
|
1271
|
+
* Include main platform data
|
|
1272
|
+
*/
|
|
1273
|
+
includeMainPlatform?: boolean;
|
|
1274
|
+
/**
|
|
1275
|
+
* start date. ISO 8601
|
|
1276
|
+
*/
|
|
1277
|
+
startDate?: string;
|
|
1278
|
+
}): CancelablePromise<OvertimeWithChangeInfo>;
|
|
819
1279
|
/**
|
|
820
1280
|
* Get time spent statistics on a per-course basis.
|
|
821
1281
|
*
|
|
@@ -834,20 +1294,42 @@ export declare class AiAnalyticsService {
|
|
|
834
1294
|
* - Total time spent (in seconds)
|
|
835
1295
|
* - Formatted time spent (human-readable)
|
|
836
1296
|
* - Percentage of total platform time
|
|
837
|
-
* @param org
|
|
838
|
-
* @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
|
|
839
|
-
* @param endDate end date. ISO 8601
|
|
840
|
-
* @param format Format
|
|
841
|
-
*
|
|
842
|
-
* * `json` - json
|
|
843
|
-
* @param includeMainPlatform Include main platform data
|
|
844
|
-
* @param length Size of data to return
|
|
845
|
-
* @param page Page offset
|
|
846
|
-
* @param startDate start date. ISO 8601
|
|
847
1297
|
* @returns TimeSpentPerCourse
|
|
848
1298
|
* @throws ApiError
|
|
849
1299
|
*/
|
|
850
|
-
static aiAnalyticsEngagementOrgsTimePerCourseRetrieve(org
|
|
1300
|
+
static aiAnalyticsEngagementOrgsTimePerCourseRetrieve({ org, departmentId, endDate, format, includeMainPlatform, length, page, startDate, }: {
|
|
1301
|
+
org: string;
|
|
1302
|
+
/**
|
|
1303
|
+
* When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
|
|
1304
|
+
*/
|
|
1305
|
+
departmentId?: number;
|
|
1306
|
+
/**
|
|
1307
|
+
* end date. ISO 8601
|
|
1308
|
+
*/
|
|
1309
|
+
endDate?: string;
|
|
1310
|
+
/**
|
|
1311
|
+
* Format
|
|
1312
|
+
*
|
|
1313
|
+
* * `json` - json
|
|
1314
|
+
*/
|
|
1315
|
+
format?: 'json';
|
|
1316
|
+
/**
|
|
1317
|
+
* Include main platform data
|
|
1318
|
+
*/
|
|
1319
|
+
includeMainPlatform?: boolean;
|
|
1320
|
+
/**
|
|
1321
|
+
* Size of data to return
|
|
1322
|
+
*/
|
|
1323
|
+
length?: number;
|
|
1324
|
+
/**
|
|
1325
|
+
* Page offset
|
|
1326
|
+
*/
|
|
1327
|
+
page?: number;
|
|
1328
|
+
/**
|
|
1329
|
+
* start date. ISO 8601
|
|
1330
|
+
*/
|
|
1331
|
+
startDate?: string;
|
|
1332
|
+
}): CancelablePromise<TimeSpentPerCourse>;
|
|
851
1333
|
/**
|
|
852
1334
|
* Get video engagement metrics on a per-course basis.
|
|
853
1335
|
*
|
|
@@ -860,18 +1342,34 @@ export declare class AiAnalyticsService {
|
|
|
860
1342
|
*
|
|
861
1343
|
* Returns:
|
|
862
1344
|
* A paginated list of courses with their video engagement metrics.
|
|
863
|
-
* @param org
|
|
864
|
-
* @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
|
|
865
|
-
* @param format Format
|
|
866
|
-
*
|
|
867
|
-
* * `json` - json
|
|
868
|
-
* @param includeMainPlatform Include main platform data
|
|
869
|
-
* @param length Size of data to return
|
|
870
|
-
* @param page Page offset
|
|
871
1345
|
* @returns VideoEngagementPerCourse
|
|
872
1346
|
* @throws ApiError
|
|
873
1347
|
*/
|
|
874
|
-
static aiAnalyticsEngagementOrgsVideosRetrieve(org
|
|
1348
|
+
static aiAnalyticsEngagementOrgsVideosRetrieve({ org, departmentId, format, includeMainPlatform, length, page, }: {
|
|
1349
|
+
org: string;
|
|
1350
|
+
/**
|
|
1351
|
+
* When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
|
|
1352
|
+
*/
|
|
1353
|
+
departmentId?: number;
|
|
1354
|
+
/**
|
|
1355
|
+
* Format
|
|
1356
|
+
*
|
|
1357
|
+
* * `json` - json
|
|
1358
|
+
*/
|
|
1359
|
+
format?: 'json';
|
|
1360
|
+
/**
|
|
1361
|
+
* Include main platform data
|
|
1362
|
+
*/
|
|
1363
|
+
includeMainPlatform?: boolean;
|
|
1364
|
+
/**
|
|
1365
|
+
* Size of data to return
|
|
1366
|
+
*/
|
|
1367
|
+
length?: number;
|
|
1368
|
+
/**
|
|
1369
|
+
* Page offset
|
|
1370
|
+
*/
|
|
1371
|
+
page?: number;
|
|
1372
|
+
}): CancelablePromise<VideoEngagementPerCourse>;
|
|
875
1373
|
/**
|
|
876
1374
|
* Get video watch counts over time.
|
|
877
1375
|
*
|
|
@@ -892,18 +1390,34 @@ export declare class AiAnalyticsService {
|
|
|
892
1390
|
* Access Control:
|
|
893
1391
|
* - Platform admins can access any video watch data
|
|
894
1392
|
* - Learners can access their own video watch data
|
|
895
|
-
* @param org
|
|
896
|
-
* @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
|
|
897
|
-
* @param endDate end date. ISO 8601
|
|
898
|
-
* @param format Format
|
|
899
|
-
*
|
|
900
|
-
* * `json` - json
|
|
901
|
-
* @param includeMainPlatform Include main platform data
|
|
902
|
-
* @param startDate start date. ISO 8601
|
|
903
1393
|
* @returns OverTimeWithTotal
|
|
904
1394
|
* @throws ApiError
|
|
905
1395
|
*/
|
|
906
|
-
static aiAnalyticsEngagementOrgsVideosOverTimeRetrieve(org
|
|
1396
|
+
static aiAnalyticsEngagementOrgsVideosOverTimeRetrieve({ org, departmentId, endDate, format, includeMainPlatform, startDate, }: {
|
|
1397
|
+
org: string;
|
|
1398
|
+
/**
|
|
1399
|
+
* When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
|
|
1400
|
+
*/
|
|
1401
|
+
departmentId?: number;
|
|
1402
|
+
/**
|
|
1403
|
+
* end date. ISO 8601
|
|
1404
|
+
*/
|
|
1405
|
+
endDate?: string;
|
|
1406
|
+
/**
|
|
1407
|
+
* Format
|
|
1408
|
+
*
|
|
1409
|
+
* * `json` - json
|
|
1410
|
+
*/
|
|
1411
|
+
format?: 'json';
|
|
1412
|
+
/**
|
|
1413
|
+
* Include main platform data
|
|
1414
|
+
*/
|
|
1415
|
+
includeMainPlatform?: boolean;
|
|
1416
|
+
/**
|
|
1417
|
+
* start date. ISO 8601
|
|
1418
|
+
*/
|
|
1419
|
+
startDate?: string;
|
|
1420
|
+
}): CancelablePromise<OverTimeWithTotal>;
|
|
907
1421
|
/**
|
|
908
1422
|
* Retrieve average message counts per session over time.
|
|
909
1423
|
*
|
|
@@ -927,17 +1441,30 @@ export declare class AiAnalyticsService {
|
|
|
927
1441
|
* end_date (str): End date for filtering (YYYY-MM-DD) - required.
|
|
928
1442
|
* mentor_id (str): Filter by mentor unique ID.
|
|
929
1443
|
* aggregation (str): Time aggregation level (hourly, daily, weekly) - default: daily.
|
|
930
|
-
* @param endDate End date for filtering (YYYY-MM-DD)
|
|
931
|
-
* @param org
|
|
932
|
-
* @param startDate Start date for filtering (YYYY-MM-DD)
|
|
933
|
-
* @param userId
|
|
934
|
-
* @param aggregation Time aggregation level (hourly, daily, weekly)
|
|
935
|
-
* @param groupBy
|
|
936
|
-
* @param mentorId Filter by mentor unique ID
|
|
937
1444
|
* @returns MessageStatistics
|
|
938
1445
|
* @throws ApiError
|
|
939
1446
|
*/
|
|
940
|
-
static aiAnalyticsOrgsUsersAverageMessagesPerSessionList(endDate
|
|
1447
|
+
static aiAnalyticsOrgsUsersAverageMessagesPerSessionList({ endDate, org, startDate, userId, aggregation, groupBy, mentorId, }: {
|
|
1448
|
+
/**
|
|
1449
|
+
* End date for filtering (YYYY-MM-DD)
|
|
1450
|
+
*/
|
|
1451
|
+
endDate: string;
|
|
1452
|
+
org: string;
|
|
1453
|
+
/**
|
|
1454
|
+
* Start date for filtering (YYYY-MM-DD)
|
|
1455
|
+
*/
|
|
1456
|
+
startDate: string;
|
|
1457
|
+
userId: string;
|
|
1458
|
+
/**
|
|
1459
|
+
* Time aggregation level (hourly, daily, weekly)
|
|
1460
|
+
*/
|
|
1461
|
+
aggregation?: 'daily' | 'hourly' | 'weekly';
|
|
1462
|
+
groupBy?: string;
|
|
1463
|
+
/**
|
|
1464
|
+
* Filter by mentor unique ID
|
|
1465
|
+
*/
|
|
1466
|
+
mentorId?: string;
|
|
1467
|
+
}): CancelablePromise<Array<MessageStatistics>>;
|
|
941
1468
|
/**
|
|
942
1469
|
* API viewset for retrieving and filtering chat message history.
|
|
943
1470
|
*
|
|
@@ -947,20 +1474,24 @@ export declare class AiAnalyticsService {
|
|
|
947
1474
|
*
|
|
948
1475
|
* Permissions:
|
|
949
1476
|
* - Restricted to platform administrators only
|
|
950
|
-
* @param org
|
|
951
|
-
* @param userId
|
|
952
|
-
* @param endDate
|
|
953
|
-
* @param filterUserId
|
|
954
|
-
* @param mentor
|
|
955
|
-
* @param page A page number within the paginated result set.
|
|
956
|
-
* @param pageSize Number of results to return per page.
|
|
957
|
-
* @param sentiment
|
|
958
|
-
* @param startDate
|
|
959
|
-
* @param topics
|
|
960
1477
|
* @returns PaginatedConversationsList
|
|
961
1478
|
* @throws ApiError
|
|
962
1479
|
*/
|
|
963
|
-
static aiAnalyticsOrgsUsersChatHistoryList(org
|
|
1480
|
+
static aiAnalyticsOrgsUsersChatHistoryList({ org, userId, endDate, filterUserId, mentor, page, pageSize, sentiment, startDate, topics, }: {
|
|
1481
|
+
org: string;
|
|
1482
|
+
endDate?: string;
|
|
1483
|
+
filterUserId?: string;
|
|
1484
|
+
mentor?: string; /**
|
|
1485
|
+
* A page number within the paginated result set.
|
|
1486
|
+
*/
|
|
1487
|
+
page?: number; /**
|
|
1488
|
+
* Number of results to return per page.
|
|
1489
|
+
*/
|
|
1490
|
+
pageSize?: number;
|
|
1491
|
+
sentiment?: string;
|
|
1492
|
+
startDate?: string;
|
|
1493
|
+
topics?: string;
|
|
1494
|
+
}): CancelablePromise<PaginatedConversationsList>;
|
|
964
1495
|
/**
|
|
965
1496
|
* API viewset for retrieving and filtering chat message history.
|
|
966
1497
|
*
|
|
@@ -970,19 +1501,19 @@ export declare class AiAnalyticsService {
|
|
|
970
1501
|
*
|
|
971
1502
|
* Permissions:
|
|
972
1503
|
* - Restricted to platform administrators only
|
|
973
|
-
* @param org
|
|
974
|
-
* @param userId
|
|
975
|
-
* @param requestBody
|
|
976
|
-
* @param endDate
|
|
977
|
-
* @param filterUserId
|
|
978
|
-
* @param mentor
|
|
979
|
-
* @param sentiment
|
|
980
|
-
* @param startDate
|
|
981
|
-
* @param topics
|
|
982
1504
|
* @returns Conversations
|
|
983
1505
|
* @throws ApiError
|
|
984
1506
|
*/
|
|
985
|
-
static aiAnalyticsOrgsUsersChatHistoryCreate(org
|
|
1507
|
+
static aiAnalyticsOrgsUsersChatHistoryCreate({ org, userId, requestBody, endDate, filterUserId, mentor, sentiment, startDate, topics, }: {
|
|
1508
|
+
org: string;
|
|
1509
|
+
requestBody: Conversations;
|
|
1510
|
+
endDate?: string;
|
|
1511
|
+
filterUserId?: string;
|
|
1512
|
+
mentor?: string;
|
|
1513
|
+
sentiment?: string;
|
|
1514
|
+
startDate?: string;
|
|
1515
|
+
topics?: string;
|
|
1516
|
+
}): CancelablePromise<Conversations>;
|
|
986
1517
|
/**
|
|
987
1518
|
* Retrieve filter options for chat message history.
|
|
988
1519
|
*
|
|
@@ -1003,16 +1534,16 @@ export declare class AiAnalyticsService {
|
|
|
1003
1534
|
* Query Parameters:
|
|
1004
1535
|
* monthly_range (bool): Whether to return monthly or weekly date ranges.
|
|
1005
1536
|
* mentor_id (str): Filter users by those who have chatted with a specific mentor.
|
|
1006
|
-
* @param org
|
|
1007
|
-
* @param userId
|
|
1008
|
-
* @param endDate
|
|
1009
|
-
* @param mentorId
|
|
1010
|
-
* @param monthlyRange
|
|
1011
|
-
* @param startDate
|
|
1012
1537
|
* @returns ChatHistoryFilterData
|
|
1013
1538
|
* @throws ApiError
|
|
1014
1539
|
*/
|
|
1015
|
-
static aiAnalyticsOrgsUsersChatHistoryFilterRetrieve(org
|
|
1540
|
+
static aiAnalyticsOrgsUsersChatHistoryFilterRetrieve({ org, userId, endDate, mentorId, monthlyRange, startDate, }: {
|
|
1541
|
+
org: string;
|
|
1542
|
+
endDate?: string;
|
|
1543
|
+
mentorId?: string;
|
|
1544
|
+
monthlyRange?: boolean;
|
|
1545
|
+
startDate?: string;
|
|
1546
|
+
}): CancelablePromise<ChatHistoryFilterData>;
|
|
1016
1547
|
/**
|
|
1017
1548
|
* API viewset for retrieving and filtering chat message history.
|
|
1018
1549
|
*
|
|
@@ -1022,19 +1553,22 @@ export declare class AiAnalyticsService {
|
|
|
1022
1553
|
*
|
|
1023
1554
|
* Permissions:
|
|
1024
1555
|
* - Restricted to platform administrators only
|
|
1025
|
-
* @param id A UUID string identifying this session.
|
|
1026
|
-
* @param org
|
|
1027
|
-
* @param userId
|
|
1028
|
-
* @param endDate
|
|
1029
|
-
* @param filterUserId
|
|
1030
|
-
* @param mentor
|
|
1031
|
-
* @param sentiment
|
|
1032
|
-
* @param startDate
|
|
1033
|
-
* @param topics
|
|
1034
1556
|
* @returns Conversations
|
|
1035
1557
|
* @throws ApiError
|
|
1036
1558
|
*/
|
|
1037
|
-
static aiAnalyticsOrgsUsersChatHistoryRetrieve(id
|
|
1559
|
+
static aiAnalyticsOrgsUsersChatHistoryRetrieve({ id, org, userId, endDate, filterUserId, mentor, sentiment, startDate, topics, }: {
|
|
1560
|
+
/**
|
|
1561
|
+
* A UUID string identifying this session.
|
|
1562
|
+
*/
|
|
1563
|
+
id: string;
|
|
1564
|
+
org: string;
|
|
1565
|
+
endDate?: string;
|
|
1566
|
+
filterUserId?: string;
|
|
1567
|
+
mentor?: string;
|
|
1568
|
+
sentiment?: string;
|
|
1569
|
+
startDate?: string;
|
|
1570
|
+
topics?: string;
|
|
1571
|
+
}): CancelablePromise<Conversations>;
|
|
1038
1572
|
/**
|
|
1039
1573
|
* API viewset for retrieving and filtering chat message history.
|
|
1040
1574
|
*
|
|
@@ -1044,20 +1578,23 @@ export declare class AiAnalyticsService {
|
|
|
1044
1578
|
*
|
|
1045
1579
|
* Permissions:
|
|
1046
1580
|
* - Restricted to platform administrators only
|
|
1047
|
-
* @param id A UUID string identifying this session.
|
|
1048
|
-
* @param org
|
|
1049
|
-
* @param userId
|
|
1050
|
-
* @param requestBody
|
|
1051
|
-
* @param endDate
|
|
1052
|
-
* @param filterUserId
|
|
1053
|
-
* @param mentor
|
|
1054
|
-
* @param sentiment
|
|
1055
|
-
* @param startDate
|
|
1056
|
-
* @param topics
|
|
1057
1581
|
* @returns Conversations
|
|
1058
1582
|
* @throws ApiError
|
|
1059
1583
|
*/
|
|
1060
|
-
static aiAnalyticsOrgsUsersChatHistoryUpdate(id
|
|
1584
|
+
static aiAnalyticsOrgsUsersChatHistoryUpdate({ id, org, userId, requestBody, endDate, filterUserId, mentor, sentiment, startDate, topics, }: {
|
|
1585
|
+
/**
|
|
1586
|
+
* A UUID string identifying this session.
|
|
1587
|
+
*/
|
|
1588
|
+
id: string;
|
|
1589
|
+
org: string;
|
|
1590
|
+
requestBody: Conversations;
|
|
1591
|
+
endDate?: string;
|
|
1592
|
+
filterUserId?: string;
|
|
1593
|
+
mentor?: string;
|
|
1594
|
+
sentiment?: string;
|
|
1595
|
+
startDate?: string;
|
|
1596
|
+
topics?: string;
|
|
1597
|
+
}): CancelablePromise<Conversations>;
|
|
1061
1598
|
/**
|
|
1062
1599
|
* API viewset for retrieving and filtering chat message history.
|
|
1063
1600
|
*
|
|
@@ -1067,20 +1604,23 @@ export declare class AiAnalyticsService {
|
|
|
1067
1604
|
*
|
|
1068
1605
|
* Permissions:
|
|
1069
1606
|
* - Restricted to platform administrators only
|
|
1070
|
-
* @param id A UUID string identifying this session.
|
|
1071
|
-
* @param org
|
|
1072
|
-
* @param userId
|
|
1073
|
-
* @param endDate
|
|
1074
|
-
* @param filterUserId
|
|
1075
|
-
* @param mentor
|
|
1076
|
-
* @param sentiment
|
|
1077
|
-
* @param startDate
|
|
1078
|
-
* @param topics
|
|
1079
|
-
* @param requestBody
|
|
1080
1607
|
* @returns Conversations
|
|
1081
1608
|
* @throws ApiError
|
|
1082
1609
|
*/
|
|
1083
|
-
static aiAnalyticsOrgsUsersChatHistoryPartialUpdate(id
|
|
1610
|
+
static aiAnalyticsOrgsUsersChatHistoryPartialUpdate({ id, org, userId, endDate, filterUserId, mentor, sentiment, startDate, topics, requestBody, }: {
|
|
1611
|
+
/**
|
|
1612
|
+
* A UUID string identifying this session.
|
|
1613
|
+
*/
|
|
1614
|
+
id: string;
|
|
1615
|
+
org: string;
|
|
1616
|
+
endDate?: string;
|
|
1617
|
+
filterUserId?: string;
|
|
1618
|
+
mentor?: string;
|
|
1619
|
+
sentiment?: string;
|
|
1620
|
+
startDate?: string;
|
|
1621
|
+
topics?: string;
|
|
1622
|
+
requestBody?: PatchedConversations;
|
|
1623
|
+
}): CancelablePromise<Conversations>;
|
|
1084
1624
|
/**
|
|
1085
1625
|
* API viewset for retrieving and filtering chat message history.
|
|
1086
1626
|
*
|
|
@@ -1090,19 +1630,22 @@ export declare class AiAnalyticsService {
|
|
|
1090
1630
|
*
|
|
1091
1631
|
* Permissions:
|
|
1092
1632
|
* - Restricted to platform administrators only
|
|
1093
|
-
* @param id A UUID string identifying this session.
|
|
1094
|
-
* @param org
|
|
1095
|
-
* @param userId
|
|
1096
|
-
* @param endDate
|
|
1097
|
-
* @param filterUserId
|
|
1098
|
-
* @param mentor
|
|
1099
|
-
* @param sentiment
|
|
1100
|
-
* @param startDate
|
|
1101
|
-
* @param topics
|
|
1102
1633
|
* @returns void
|
|
1103
1634
|
* @throws ApiError
|
|
1104
1635
|
*/
|
|
1105
|
-
static aiAnalyticsOrgsUsersChatHistoryDestroy(id
|
|
1636
|
+
static aiAnalyticsOrgsUsersChatHistoryDestroy({ id, org, userId, endDate, filterUserId, mentor, sentiment, startDate, topics, }: {
|
|
1637
|
+
/**
|
|
1638
|
+
* A UUID string identifying this session.
|
|
1639
|
+
*/
|
|
1640
|
+
id: string;
|
|
1641
|
+
org: string;
|
|
1642
|
+
endDate?: string;
|
|
1643
|
+
filterUserId?: string;
|
|
1644
|
+
mentor?: string;
|
|
1645
|
+
sentiment?: string;
|
|
1646
|
+
startDate?: string;
|
|
1647
|
+
topics?: string;
|
|
1648
|
+
}): CancelablePromise<void>;
|
|
1106
1649
|
/**
|
|
1107
1650
|
* Retrieve conversation volume data over time.
|
|
1108
1651
|
*
|
|
@@ -1127,16 +1670,29 @@ export declare class AiAnalyticsService {
|
|
|
1127
1670
|
* end_date (str): End date for filtering (YYYY-MM-DD) - required.
|
|
1128
1671
|
* mentor_id (str): Filter by mentor unique ID.
|
|
1129
1672
|
* aggregation (str): Time aggregation level (hourly, daily, weekly) - default: daily.
|
|
1130
|
-
* @param endDate End date for filtering (YYYY-MM-DD)
|
|
1131
|
-
* @param org
|
|
1132
|
-
* @param startDate Start date for filtering (YYYY-MM-DD)
|
|
1133
|
-
* @param userId
|
|
1134
|
-
* @param aggregation Time aggregation level (hourly, daily, weekly)
|
|
1135
|
-
* @param mentorId Filter by mentor unique ID
|
|
1136
1673
|
* @returns ConversationVolume
|
|
1137
1674
|
* @throws ApiError
|
|
1138
1675
|
*/
|
|
1139
|
-
static aiAnalyticsOrgsUsersConversationList(endDate
|
|
1676
|
+
static aiAnalyticsOrgsUsersConversationList({ endDate, org, startDate, userId, aggregation, mentorId, }: {
|
|
1677
|
+
/**
|
|
1678
|
+
* End date for filtering (YYYY-MM-DD)
|
|
1679
|
+
*/
|
|
1680
|
+
endDate: string;
|
|
1681
|
+
org: string;
|
|
1682
|
+
/**
|
|
1683
|
+
* Start date for filtering (YYYY-MM-DD)
|
|
1684
|
+
*/
|
|
1685
|
+
startDate: string;
|
|
1686
|
+
userId: string;
|
|
1687
|
+
/**
|
|
1688
|
+
* Time aggregation level (hourly, daily, weekly)
|
|
1689
|
+
*/
|
|
1690
|
+
aggregation?: 'daily' | 'hourly' | 'weekly';
|
|
1691
|
+
/**
|
|
1692
|
+
* Filter by mentor unique ID
|
|
1693
|
+
*/
|
|
1694
|
+
mentorId?: string;
|
|
1695
|
+
}): CancelablePromise<Array<ConversationVolume>>;
|
|
1140
1696
|
/**
|
|
1141
1697
|
* Retrieve a summary of conversation metrics.
|
|
1142
1698
|
*
|
|
@@ -1160,28 +1716,30 @@ export declare class AiAnalyticsService {
|
|
|
1160
1716
|
*
|
|
1161
1717
|
* Query Parameters:
|
|
1162
1718
|
* mentor_id (str): Filter by mentor unique ID.
|
|
1163
|
-
* @param org
|
|
1164
|
-
* @param userId
|
|
1165
|
-
* @param groupBy
|
|
1166
|
-
* @param mentorId Filter by mentor unique ID
|
|
1167
1719
|
* @returns ConversationSummary
|
|
1168
1720
|
* @throws ApiError
|
|
1169
1721
|
*/
|
|
1170
|
-
static aiAnalyticsOrgsUsersConversationSummaryRetrieve(org
|
|
1722
|
+
static aiAnalyticsOrgsUsersConversationSummaryRetrieve({ org, userId, groupBy, mentorId, }: {
|
|
1723
|
+
org: string;
|
|
1724
|
+
groupBy?: string; /**
|
|
1725
|
+
* Filter by mentor unique ID
|
|
1726
|
+
*/
|
|
1727
|
+
mentorId?: string;
|
|
1728
|
+
}): CancelablePromise<ConversationSummary>;
|
|
1171
1729
|
/**
|
|
1172
1730
|
* Retrieve the model costs for a tenant
|
|
1173
1731
|
*
|
|
1174
1732
|
* Filter parameters for period are start_date and enddate
|
|
1175
1733
|
*
|
|
1176
1734
|
* Accessible to tenant Admins only.
|
|
1177
|
-
* @param endDate
|
|
1178
|
-
* @param org
|
|
1179
|
-
* @param startDate
|
|
1180
|
-
* @param userId
|
|
1181
1735
|
* @returns ModelCost
|
|
1182
1736
|
* @throws ApiError
|
|
1183
1737
|
*/
|
|
1184
|
-
static aiAnalyticsOrgsUsersCostsModelRetrieve(endDate
|
|
1738
|
+
static aiAnalyticsOrgsUsersCostsModelRetrieve({ endDate, org, startDate, userId, }: {
|
|
1739
|
+
endDate: string;
|
|
1740
|
+
org: string;
|
|
1741
|
+
startDate: string;
|
|
1742
|
+
}): CancelablePromise<ModelCost>;
|
|
1185
1743
|
/**
|
|
1186
1744
|
* Retrieve LLM usage costs aggregated by mentor.
|
|
1187
1745
|
*
|
|
@@ -1206,14 +1764,14 @@ export declare class AiAnalyticsService {
|
|
|
1206
1764
|
* end_date (str): End date for filtering (YYYY-MM-DD) - required.
|
|
1207
1765
|
* limit (int): Number of results per page - default: 5.
|
|
1208
1766
|
* offset (int): Offset for pagination - default: 0.
|
|
1209
|
-
* @param endDate
|
|
1210
|
-
* @param org
|
|
1211
|
-
* @param startDate
|
|
1212
|
-
* @param userId
|
|
1213
1767
|
* @returns TenantMentorTraces
|
|
1214
1768
|
* @throws ApiError
|
|
1215
1769
|
*/
|
|
1216
|
-
static aiAnalyticsOrgsUsersCostsPermentorRetrieve(endDate
|
|
1770
|
+
static aiAnalyticsOrgsUsersCostsPermentorRetrieve({ endDate, org, startDate, userId, }: {
|
|
1771
|
+
endDate: string;
|
|
1772
|
+
org: string;
|
|
1773
|
+
startDate: string;
|
|
1774
|
+
}): CancelablePromise<TenantMentorTraces>;
|
|
1217
1775
|
/**
|
|
1218
1776
|
* Retrieve LLM usage costs aggregated by user.
|
|
1219
1777
|
*
|
|
@@ -1238,14 +1796,14 @@ export declare class AiAnalyticsService {
|
|
|
1238
1796
|
* end_date (str): End date for filtering (YYYY-MM-DD) - required.
|
|
1239
1797
|
* limit (int): Number of results per page - default: 10.
|
|
1240
1798
|
* offset (int): Offset for pagination - default: 0.
|
|
1241
|
-
* @param endDate
|
|
1242
|
-
* @param org
|
|
1243
|
-
* @param startDate
|
|
1244
|
-
* @param userId
|
|
1245
1799
|
* @returns LLMTracesListResponse
|
|
1246
1800
|
* @throws ApiError
|
|
1247
1801
|
*/
|
|
1248
|
-
static aiAnalyticsOrgsUsersCostsPeruserRetrieve(endDate
|
|
1802
|
+
static aiAnalyticsOrgsUsersCostsPeruserRetrieve({ endDate, org, startDate, userId, }: {
|
|
1803
|
+
endDate: string;
|
|
1804
|
+
org: string;
|
|
1805
|
+
startDate: string;
|
|
1806
|
+
}): CancelablePromise<LLMTracesListResponse>;
|
|
1249
1807
|
/**
|
|
1250
1808
|
* Retrieve summary statistics about mentors.
|
|
1251
1809
|
*
|
|
@@ -1262,12 +1820,12 @@ export declare class AiAnalyticsService {
|
|
|
1262
1820
|
*
|
|
1263
1821
|
* Raises:
|
|
1264
1822
|
* NotFound: If the specified organization does not exist.
|
|
1265
|
-
* @param org
|
|
1266
|
-
* @param userId
|
|
1267
1823
|
* @returns MentorDetailAnalytics
|
|
1268
1824
|
* @throws ApiError
|
|
1269
1825
|
*/
|
|
1270
|
-
static aiAnalyticsOrgsUsersMentorDetailRetrieve(org
|
|
1826
|
+
static aiAnalyticsOrgsUsersMentorDetailRetrieve({ org, userId, }: {
|
|
1827
|
+
org: string;
|
|
1828
|
+
}): CancelablePromise<MentorDetailAnalytics>;
|
|
1271
1829
|
/**
|
|
1272
1830
|
* Retrieve summary statistics about mentors.
|
|
1273
1831
|
*
|
|
@@ -1284,12 +1842,12 @@ export declare class AiAnalyticsService {
|
|
|
1284
1842
|
*
|
|
1285
1843
|
* Raises:
|
|
1286
1844
|
* NotFound: If the specified organization does not exist.
|
|
1287
|
-
* @param org
|
|
1288
|
-
* @param userId
|
|
1289
1845
|
* @returns MentorDetailAnalytics
|
|
1290
1846
|
* @throws ApiError
|
|
1291
1847
|
*/
|
|
1292
|
-
static aiAnalyticsOrgsUsersMentorSummaryRetrieve(org
|
|
1848
|
+
static aiAnalyticsOrgsUsersMentorSummaryRetrieve({ org, userId, }: {
|
|
1849
|
+
org: string;
|
|
1850
|
+
}): CancelablePromise<MentorDetailAnalytics>;
|
|
1293
1851
|
/**
|
|
1294
1852
|
* Retrieve LLM usage costs for a specific mentor.
|
|
1295
1853
|
*
|
|
@@ -1312,15 +1870,15 @@ export declare class AiAnalyticsService {
|
|
|
1312
1870
|
* Query Parameters:
|
|
1313
1871
|
* start_date (str): Start date for filtering (YYYY-MM-DD) - required.
|
|
1314
1872
|
* end_date (str): End date for filtering (YYYY-MM-DD) - required.
|
|
1315
|
-
* @param endDate
|
|
1316
|
-
* @param mentorUniqueId
|
|
1317
|
-
* @param org
|
|
1318
|
-
* @param startDate
|
|
1319
|
-
* @param userId
|
|
1320
1873
|
* @returns Cost
|
|
1321
1874
|
* @throws ApiError
|
|
1322
1875
|
*/
|
|
1323
|
-
static aiAnalyticsOrgsUsersMentorsCostRetrieve(endDate
|
|
1876
|
+
static aiAnalyticsOrgsUsersMentorsCostRetrieve({ endDate, mentorUniqueId, org, startDate, userId, }: {
|
|
1877
|
+
endDate: string;
|
|
1878
|
+
mentorUniqueId: string;
|
|
1879
|
+
org: string;
|
|
1880
|
+
startDate: string;
|
|
1881
|
+
}): CancelablePromise<Cost>;
|
|
1324
1882
|
/**
|
|
1325
1883
|
* Retrieve the most discussed topics over time.
|
|
1326
1884
|
*
|
|
@@ -1344,17 +1902,30 @@ export declare class AiAnalyticsService {
|
|
|
1344
1902
|
* end_date (str): End date for filtering (YYYY-MM-DD) - required.
|
|
1345
1903
|
* mentor_id (str): Filter by mentor unique ID.
|
|
1346
1904
|
* aggregation (str): Time aggregation level (hourly, daily, weekly) - default: daily.
|
|
1347
|
-
* @param endDate End date for filtering (YYYY-MM-DD)
|
|
1348
|
-
* @param org
|
|
1349
|
-
* @param startDate Start date for filtering (YYYY-MM-DD)
|
|
1350
|
-
* @param userId
|
|
1351
|
-
* @param aggregation Time aggregation level (hourly, daily, weekly)
|
|
1352
|
-
* @param groupBy
|
|
1353
|
-
* @param mentorId Filter by mentor unique ID
|
|
1354
1905
|
* @returns TopicRecord
|
|
1355
1906
|
* @throws ApiError
|
|
1356
1907
|
*/
|
|
1357
|
-
static aiAnalyticsOrgsUsersMostDiscussedTopicsList(endDate
|
|
1908
|
+
static aiAnalyticsOrgsUsersMostDiscussedTopicsList({ endDate, org, startDate, userId, aggregation, groupBy, mentorId, }: {
|
|
1909
|
+
/**
|
|
1910
|
+
* End date for filtering (YYYY-MM-DD)
|
|
1911
|
+
*/
|
|
1912
|
+
endDate: string;
|
|
1913
|
+
org: string;
|
|
1914
|
+
/**
|
|
1915
|
+
* Start date for filtering (YYYY-MM-DD)
|
|
1916
|
+
*/
|
|
1917
|
+
startDate: string;
|
|
1918
|
+
userId: string;
|
|
1919
|
+
/**
|
|
1920
|
+
* Time aggregation level (hourly, daily, weekly)
|
|
1921
|
+
*/
|
|
1922
|
+
aggregation?: 'daily' | 'hourly' | 'weekly';
|
|
1923
|
+
groupBy?: string;
|
|
1924
|
+
/**
|
|
1925
|
+
* Filter by mentor unique ID
|
|
1926
|
+
*/
|
|
1927
|
+
mentorId?: string;
|
|
1928
|
+
}): CancelablePromise<Array<TopicRecord>>;
|
|
1358
1929
|
/**
|
|
1359
1930
|
* Retrieve an overview of key analytics metrics.
|
|
1360
1931
|
*
|
|
@@ -1380,14 +1951,16 @@ export declare class AiAnalyticsService {
|
|
|
1380
1951
|
*
|
|
1381
1952
|
* Query Parameters:
|
|
1382
1953
|
* mentor_id (str): Filter analytics by mentor unique ID.
|
|
1383
|
-
* @param org
|
|
1384
|
-
* @param userId
|
|
1385
|
-
* @param groupBy
|
|
1386
|
-
* @param mentorId Filter analytics by mentor unique ID
|
|
1387
1954
|
* @returns AnalyticsOverview
|
|
1388
1955
|
* @throws ApiError
|
|
1389
1956
|
*/
|
|
1390
|
-
static aiAnalyticsOrgsUsersOverviewSummaryRetrieve(org
|
|
1957
|
+
static aiAnalyticsOrgsUsersOverviewSummaryRetrieve({ org, userId, groupBy, mentorId, }: {
|
|
1958
|
+
org: string;
|
|
1959
|
+
groupBy?: string; /**
|
|
1960
|
+
* Filter analytics by mentor unique ID
|
|
1961
|
+
*/
|
|
1962
|
+
mentorId?: string;
|
|
1963
|
+
}): CancelablePromise<AnalyticsOverview>;
|
|
1391
1964
|
/**
|
|
1392
1965
|
* Retrieve user rating metrics over time.
|
|
1393
1966
|
*
|
|
@@ -1409,15 +1982,25 @@ export declare class AiAnalyticsService {
|
|
|
1409
1982
|
* start_date (str): Start date for filtering (YYYY-MM-DD) - required.
|
|
1410
1983
|
* end_date (str): End date for filtering (YYYY-MM-DD) - required.
|
|
1411
1984
|
* group_by (str): Aggregation level (day or hour) - default: day.
|
|
1412
|
-
* @param endDate End date for filtering (YYYY-MM-DD)
|
|
1413
|
-
* @param org
|
|
1414
|
-
* @param startDate Start date for filtering (YYYY-MM-DD)
|
|
1415
|
-
* @param userId
|
|
1416
|
-
* @param groupBy Aggregation level (day or hour)
|
|
1417
1985
|
* @returns RatingRecord
|
|
1418
1986
|
* @throws ApiError
|
|
1419
1987
|
*/
|
|
1420
|
-
static aiAnalyticsOrgsUsersRatingSummaryList(endDate
|
|
1988
|
+
static aiAnalyticsOrgsUsersRatingSummaryList({ endDate, org, startDate, userId, groupBy, }: {
|
|
1989
|
+
/**
|
|
1990
|
+
* End date for filtering (YYYY-MM-DD)
|
|
1991
|
+
*/
|
|
1992
|
+
endDate: string;
|
|
1993
|
+
org: string;
|
|
1994
|
+
/**
|
|
1995
|
+
* Start date for filtering (YYYY-MM-DD)
|
|
1996
|
+
*/
|
|
1997
|
+
startDate: string;
|
|
1998
|
+
userId: string;
|
|
1999
|
+
/**
|
|
2000
|
+
* Aggregation level (day or hour)
|
|
2001
|
+
*/
|
|
2002
|
+
groupBy?: 'day' | 'hour';
|
|
2003
|
+
}): CancelablePromise<Array<RatingRecord>>;
|
|
1421
2004
|
/**
|
|
1422
2005
|
* Retrieve trends of registered users over time.
|
|
1423
2006
|
*
|
|
@@ -1441,16 +2024,26 @@ export declare class AiAnalyticsService {
|
|
|
1441
2024
|
* start_date (str): Start date for filtering (YYYY-MM-DD) - required.
|
|
1442
2025
|
* end_date (str): End date for filtering (YYYY-MM-DD) - required.
|
|
1443
2026
|
* aggregation (str): Time aggregation level (hourly, daily, weekly, monthly) - default: daily.
|
|
1444
|
-
* @param endDate End date for filtering (YYYY-MM-DD)
|
|
1445
|
-
* @param org
|
|
1446
|
-
* @param startDate Start date for filtering (YYYY-MM-DD)
|
|
1447
|
-
* @param userId
|
|
1448
|
-
* @param aggregation Time aggregation level (hourly, daily, weekly, monthly)
|
|
1449
|
-
* @param groupBy
|
|
1450
2027
|
* @returns TrendEntry
|
|
1451
2028
|
* @throws ApiError
|
|
1452
2029
|
*/
|
|
1453
|
-
static aiAnalyticsOrgsUsersRegisteredUsersTrendList(endDate
|
|
2030
|
+
static aiAnalyticsOrgsUsersRegisteredUsersTrendList({ endDate, org, startDate, userId, aggregation, groupBy, }: {
|
|
2031
|
+
/**
|
|
2032
|
+
* End date for filtering (YYYY-MM-DD)
|
|
2033
|
+
*/
|
|
2034
|
+
endDate: string;
|
|
2035
|
+
org: string;
|
|
2036
|
+
/**
|
|
2037
|
+
* Start date for filtering (YYYY-MM-DD)
|
|
2038
|
+
*/
|
|
2039
|
+
startDate: string;
|
|
2040
|
+
userId: string;
|
|
2041
|
+
/**
|
|
2042
|
+
* Time aggregation level (hourly, daily, weekly, monthly)
|
|
2043
|
+
*/
|
|
2044
|
+
aggregation?: 'daily' | 'hourly' | 'monthly' | 'weekly';
|
|
2045
|
+
groupBy?: string;
|
|
2046
|
+
}): CancelablePromise<Array<TrendEntry>>;
|
|
1454
2047
|
/**
|
|
1455
2048
|
* Retrieve user sentiment counts over time.
|
|
1456
2049
|
*
|
|
@@ -1471,13 +2064,13 @@ export declare class AiAnalyticsService {
|
|
|
1471
2064
|
*
|
|
1472
2065
|
* Query Parameters:
|
|
1473
2066
|
* period (str): Time period filter (today, yesterday, 7d, 30d, 90d) - default: 7d.
|
|
1474
|
-
* @param org
|
|
1475
|
-
* @param userId
|
|
1476
|
-
* @param period
|
|
1477
2067
|
* @returns UserSentimentCountView
|
|
1478
2068
|
* @throws ApiError
|
|
1479
2069
|
*/
|
|
1480
|
-
static aiAnalyticsOrgsUsersSentimentCountList(org
|
|
2070
|
+
static aiAnalyticsOrgsUsersSentimentCountList({ org, userId, period, }: {
|
|
2071
|
+
org: string;
|
|
2072
|
+
period?: string;
|
|
2073
|
+
}): CancelablePromise<Array<UserSentimentCountView>>;
|
|
1481
2074
|
/**
|
|
1482
2075
|
* Retrieve LLM usage costs for a specific tenant.
|
|
1483
2076
|
*
|
|
@@ -1499,14 +2092,14 @@ export declare class AiAnalyticsService {
|
|
|
1499
2092
|
* Query Parameters:
|
|
1500
2093
|
* start_date (str): Start date for filtering (YYYY-MM-DD) - required.
|
|
1501
2094
|
* end_date (str): End date for filtering (YYYY-MM-DD) - required.
|
|
1502
|
-
* @param endDate
|
|
1503
|
-
* @param org
|
|
1504
|
-
* @param startDate
|
|
1505
|
-
* @param userId
|
|
1506
2095
|
* @returns Cost
|
|
1507
2096
|
* @throws ApiError
|
|
1508
2097
|
*/
|
|
1509
|
-
static aiAnalyticsOrgsUsersTenantCostRetrieve(endDate
|
|
2098
|
+
static aiAnalyticsOrgsUsersTenantCostRetrieve({ endDate, org, startDate, userId, }: {
|
|
2099
|
+
endDate: string;
|
|
2100
|
+
org: string;
|
|
2101
|
+
startDate: string;
|
|
2102
|
+
}): CancelablePromise<Cost>;
|
|
1510
2103
|
/**
|
|
1511
2104
|
* Retrieve the most engaged students based on chat message count.
|
|
1512
2105
|
*
|
|
@@ -1529,13 +2122,13 @@ export declare class AiAnalyticsService {
|
|
|
1529
2122
|
* mentor_id (str): Filter by mentor unique ID.
|
|
1530
2123
|
* start_date (str): Start date for filtering (YYYY-MM-DD).
|
|
1531
2124
|
* end_date (str): End date for filtering (YYYY-MM-DD).
|
|
1532
|
-
* @param org
|
|
1533
|
-
* @param userId
|
|
1534
|
-
* @param groupBy
|
|
1535
2125
|
* @returns StudentChatMessage
|
|
1536
2126
|
* @throws ApiError
|
|
1537
2127
|
*/
|
|
1538
|
-
static aiAnalyticsOrgsUsersTopStudentsByChatMessagesList(org
|
|
2128
|
+
static aiAnalyticsOrgsUsersTopStudentsByChatMessagesList({ org, userId, groupBy, }: {
|
|
2129
|
+
org: string;
|
|
2130
|
+
groupBy?: string;
|
|
2131
|
+
}): CancelablePromise<Array<StudentChatMessage>>;
|
|
1539
2132
|
/**
|
|
1540
2133
|
* Retrieve aggregated topic statistics.
|
|
1541
2134
|
*
|
|
@@ -1555,13 +2148,15 @@ export declare class AiAnalyticsService {
|
|
|
1555
2148
|
*
|
|
1556
2149
|
* Query Parameters:
|
|
1557
2150
|
* mentor_id (str): Filter statistics by mentor unique ID.
|
|
1558
|
-
* @param org
|
|
1559
|
-
* @param userId
|
|
1560
|
-
* @param mentorId Filter statistics by mentor unique ID
|
|
1561
2151
|
* @returns TopicStatisticsResponse
|
|
1562
2152
|
* @throws ApiError
|
|
1563
2153
|
*/
|
|
1564
|
-
static aiAnalyticsOrgsUsersTopicOverviewRetrieve(org
|
|
2154
|
+
static aiAnalyticsOrgsUsersTopicOverviewRetrieve({ org, userId, mentorId, }: {
|
|
2155
|
+
org: string; /**
|
|
2156
|
+
* Filter statistics by mentor unique ID
|
|
2157
|
+
*/
|
|
2158
|
+
mentorId?: string;
|
|
2159
|
+
}): CancelablePromise<TopicStatisticsResponse>;
|
|
1565
2160
|
/**
|
|
1566
2161
|
* Retrieve paginated statistics about topics.
|
|
1567
2162
|
*
|
|
@@ -1590,18 +2185,32 @@ export declare class AiAnalyticsService {
|
|
|
1590
2185
|
* mentor_id (str): Filter by mentor unique ID.
|
|
1591
2186
|
* page (int): Page number for pagination - default: 1.
|
|
1592
2187
|
* page_size (int): Number of results per page - default: 20.
|
|
1593
|
-
* @param org
|
|
1594
|
-
* @param userId
|
|
1595
|
-
* @param endDate End date for filtering (YYYY-MM-DD)
|
|
1596
|
-
* @param groupBy
|
|
1597
|
-
* @param mentorId Filter by mentor unique ID
|
|
1598
|
-
* @param page Page number for pagination
|
|
1599
|
-
* @param pageSize Number of results per page
|
|
1600
|
-
* @param startDate Start date for filtering (YYYY-MM-DD)
|
|
1601
2188
|
* @returns PaginatedTopicStatisticsResponse
|
|
1602
2189
|
* @throws ApiError
|
|
1603
2190
|
*/
|
|
1604
|
-
static aiAnalyticsOrgsUsersTopicStatisticsRetrieve(org
|
|
2191
|
+
static aiAnalyticsOrgsUsersTopicStatisticsRetrieve({ org, userId, endDate, groupBy, mentorId, page, pageSize, startDate, }: {
|
|
2192
|
+
org: string; /**
|
|
2193
|
+
* End date for filtering (YYYY-MM-DD)
|
|
2194
|
+
*/
|
|
2195
|
+
endDate?: string;
|
|
2196
|
+
groupBy?: string;
|
|
2197
|
+
/**
|
|
2198
|
+
* Filter by mentor unique ID
|
|
2199
|
+
*/
|
|
2200
|
+
mentorId?: string;
|
|
2201
|
+
/**
|
|
2202
|
+
* Page number for pagination
|
|
2203
|
+
*/
|
|
2204
|
+
page?: number;
|
|
2205
|
+
/**
|
|
2206
|
+
* Number of results per page
|
|
2207
|
+
*/
|
|
2208
|
+
pageSize?: number;
|
|
2209
|
+
/**
|
|
2210
|
+
* Start date for filtering (YYYY-MM-DD)
|
|
2211
|
+
*/
|
|
2212
|
+
startDate?: string;
|
|
2213
|
+
}): CancelablePromise<PaginatedTopicStatisticsResponse>;
|
|
1605
2214
|
/**
|
|
1606
2215
|
* Retrieve a summary of the most frequent topics.
|
|
1607
2216
|
*
|
|
@@ -1623,14 +2232,14 @@ export declare class AiAnalyticsService {
|
|
|
1623
2232
|
* mentor_id (str): Filter by mentor unique ID.
|
|
1624
2233
|
* start_date (str): Start date for filtering (YYYY-MM-DD).
|
|
1625
2234
|
* end_date (str): End date for filtering (YYYY-MM-DD).
|
|
1626
|
-
* @param org
|
|
1627
|
-
* @param userId
|
|
1628
|
-
* @param endDate
|
|
1629
|
-
* @param startDate
|
|
1630
2235
|
* @returns TopicSummaryView
|
|
1631
2236
|
* @throws ApiError
|
|
1632
2237
|
*/
|
|
1633
|
-
static aiAnalyticsOrgsUsersTopicsSummaryList(org
|
|
2238
|
+
static aiAnalyticsOrgsUsersTopicsSummaryList({ org, userId, endDate, startDate, }: {
|
|
2239
|
+
org: string;
|
|
2240
|
+
endDate?: string;
|
|
2241
|
+
startDate?: string;
|
|
2242
|
+
}): CancelablePromise<Array<TopicSummaryView>>;
|
|
1634
2243
|
/**
|
|
1635
2244
|
* Retrieve the total number of users interacting with mentors over time.
|
|
1636
2245
|
*
|
|
@@ -1655,17 +2264,28 @@ export declare class AiAnalyticsService {
|
|
|
1655
2264
|
* end_date (str): End date for filtering (YYYY-MM-DD) - defaults to today.
|
|
1656
2265
|
* aggregation (str): Time aggregation level (hourly, daily) - default: daily.
|
|
1657
2266
|
* mentor_id (str): Filter by mentor unique ID.
|
|
1658
|
-
* @param org
|
|
1659
|
-
* @param userId
|
|
1660
|
-
* @param aggregation Time aggregation level (hourly, daily)
|
|
1661
|
-
* @param endDate End date for filtering (YYYY-MM-DD)
|
|
1662
|
-
* @param groupBy
|
|
1663
|
-
* @param mentorId Filter by mentor unique ID
|
|
1664
|
-
* @param startDate Start date for filtering (YYYY-MM-DD)
|
|
1665
2267
|
* @returns UserChatByPeriod
|
|
1666
2268
|
* @throws ApiError
|
|
1667
2269
|
*/
|
|
1668
|
-
static aiAnalyticsOrgsUsersTotalUsersByMentorList(org
|
|
2270
|
+
static aiAnalyticsOrgsUsersTotalUsersByMentorList({ org, userId, aggregation, endDate, groupBy, mentorId, startDate, }: {
|
|
2271
|
+
org: string; /**
|
|
2272
|
+
* Time aggregation level (hourly, daily)
|
|
2273
|
+
*/
|
|
2274
|
+
aggregation?: 'daily' | 'hourly';
|
|
2275
|
+
/**
|
|
2276
|
+
* End date for filtering (YYYY-MM-DD)
|
|
2277
|
+
*/
|
|
2278
|
+
endDate?: string;
|
|
2279
|
+
groupBy?: string;
|
|
2280
|
+
/**
|
|
2281
|
+
* Filter by mentor unique ID
|
|
2282
|
+
*/
|
|
2283
|
+
mentorId?: string;
|
|
2284
|
+
/**
|
|
2285
|
+
* Start date for filtering (YYYY-MM-DD)
|
|
2286
|
+
*/
|
|
2287
|
+
startDate?: string;
|
|
2288
|
+
}): CancelablePromise<Array<UserChatByPeriod>>;
|
|
1669
2289
|
/**
|
|
1670
2290
|
* Retrieve message data from conversations.
|
|
1671
2291
|
*
|
|
@@ -1689,16 +2309,16 @@ export declare class AiAnalyticsService {
|
|
|
1689
2309
|
* end_date (str): End date for filtering (YYYY-MM-DD).
|
|
1690
2310
|
* topics (str): Comma-separated list of topics to filter by.
|
|
1691
2311
|
* mentor (str): Filter by mentor unique ID.
|
|
1692
|
-
* @param org
|
|
1693
|
-
* @param userId
|
|
1694
|
-
* @param endDate
|
|
1695
|
-
* @param mentor
|
|
1696
|
-
* @param startDate
|
|
1697
|
-
* @param topics
|
|
1698
2312
|
* @returns ConversationMessage
|
|
1699
2313
|
* @throws ApiError
|
|
1700
2314
|
*/
|
|
1701
|
-
static aiAnalyticsOrgsUsersTranscriptsList(org
|
|
2315
|
+
static aiAnalyticsOrgsUsersTranscriptsList({ org, userId, endDate, mentor, startDate, topics, }: {
|
|
2316
|
+
org: string;
|
|
2317
|
+
endDate?: string;
|
|
2318
|
+
mentor?: string;
|
|
2319
|
+
startDate?: string;
|
|
2320
|
+
topics?: string;
|
|
2321
|
+
}): CancelablePromise<Array<ConversationMessage>>;
|
|
1702
2322
|
/**
|
|
1703
2323
|
* Retrieve daily user engagement metrics with mentors.
|
|
1704
2324
|
*
|
|
@@ -1719,15 +2339,22 @@ export declare class AiAnalyticsService {
|
|
|
1719
2339
|
* Query Parameters:
|
|
1720
2340
|
* start_date (str): Start date for filtering (YYYY-MM-DD) - required.
|
|
1721
2341
|
* end_date (str): End date for filtering (YYYY-MM-DD) - required.
|
|
1722
|
-
* @param endDate End date for filtering (YYYY-MM-DD)
|
|
1723
|
-
* @param org
|
|
1724
|
-
* @param startDate Start date for filtering (YYYY-MM-DD)
|
|
1725
|
-
* @param userId
|
|
1726
|
-
* @param groupBy
|
|
1727
2342
|
* @returns UserCountRecord
|
|
1728
2343
|
* @throws ApiError
|
|
1729
2344
|
*/
|
|
1730
|
-
static aiAnalyticsOrgsUsersUsageSummaryList(endDate
|
|
2345
|
+
static aiAnalyticsOrgsUsersUsageSummaryList({ endDate, org, startDate, userId, groupBy, }: {
|
|
2346
|
+
/**
|
|
2347
|
+
* End date for filtering (YYYY-MM-DD)
|
|
2348
|
+
*/
|
|
2349
|
+
endDate: string;
|
|
2350
|
+
org: string;
|
|
2351
|
+
/**
|
|
2352
|
+
* Start date for filtering (YYYY-MM-DD)
|
|
2353
|
+
*/
|
|
2354
|
+
startDate: string;
|
|
2355
|
+
userId: string;
|
|
2356
|
+
groupBy?: string;
|
|
2357
|
+
}): CancelablePromise<Array<UserCountRecord>>;
|
|
1731
2358
|
/**
|
|
1732
2359
|
* Retrieve user cohort trends over time.
|
|
1733
2360
|
*
|
|
@@ -1753,16 +2380,29 @@ export declare class AiAnalyticsService {
|
|
|
1753
2380
|
* end_date (str): End date for filtering (YYYY-MM-DD) - required.
|
|
1754
2381
|
* aggregation (str): Time aggregation level (hourly, daily, weekly) - default: daily.
|
|
1755
2382
|
* mentor_id (str): Filter by mentor unique ID.
|
|
1756
|
-
* @param endDate End date for filtering (YYYY-MM-DD)
|
|
1757
|
-
* @param org
|
|
1758
|
-
* @param startDate Start date for filtering (YYYY-MM-DD)
|
|
1759
|
-
* @param userId
|
|
1760
|
-
* @param aggregation Time aggregation level (hourly, daily, weekly)
|
|
1761
|
-
* @param mentorId Filter by mentor unique ID
|
|
1762
2383
|
* @returns UserTrendByPeriod
|
|
1763
2384
|
* @throws ApiError
|
|
1764
2385
|
*/
|
|
1765
|
-
static aiAnalyticsOrgsUsersUserCohortsOverTimeRetrieve(endDate
|
|
2386
|
+
static aiAnalyticsOrgsUsersUserCohortsOverTimeRetrieve({ endDate, org, startDate, userId, aggregation, mentorId, }: {
|
|
2387
|
+
/**
|
|
2388
|
+
* End date for filtering (YYYY-MM-DD)
|
|
2389
|
+
*/
|
|
2390
|
+
endDate: string;
|
|
2391
|
+
org: string;
|
|
2392
|
+
/**
|
|
2393
|
+
* Start date for filtering (YYYY-MM-DD)
|
|
2394
|
+
*/
|
|
2395
|
+
startDate: string;
|
|
2396
|
+
userId: string;
|
|
2397
|
+
/**
|
|
2398
|
+
* Time aggregation level (hourly, daily, weekly)
|
|
2399
|
+
*/
|
|
2400
|
+
aggregation?: 'daily' | 'hourly' | 'weekly';
|
|
2401
|
+
/**
|
|
2402
|
+
* Filter by mentor unique ID
|
|
2403
|
+
*/
|
|
2404
|
+
mentorId?: string;
|
|
2405
|
+
}): CancelablePromise<UserTrendByPeriod>;
|
|
1766
2406
|
/**
|
|
1767
2407
|
* Retrieve LLM usage costs for a specific user.
|
|
1768
2408
|
*
|
|
@@ -1785,15 +2425,15 @@ export declare class AiAnalyticsService {
|
|
|
1785
2425
|
* Query Parameters:
|
|
1786
2426
|
* start_date (str): Start date for filtering (YYYY-MM-DD) - required.
|
|
1787
2427
|
* end_date (str): End date for filtering (YYYY-MM-DD) - required.
|
|
1788
|
-
* @param endDate
|
|
1789
|
-
* @param org
|
|
1790
|
-
* @param startDate
|
|
1791
|
-
* @param userId
|
|
1792
|
-
* @param username
|
|
1793
2428
|
* @returns Cost
|
|
1794
2429
|
* @throws ApiError
|
|
1795
2430
|
*/
|
|
1796
|
-
static aiAnalyticsOrgsUsersUserCostRetrieve(endDate
|
|
2431
|
+
static aiAnalyticsOrgsUsersUserCostRetrieve({ endDate, org, startDate, userId, username, }: {
|
|
2432
|
+
endDate: string;
|
|
2433
|
+
org: string;
|
|
2434
|
+
startDate: string;
|
|
2435
|
+
username: string;
|
|
2436
|
+
}): CancelablePromise<Cost>;
|
|
1797
2437
|
/**
|
|
1798
2438
|
* Retrieve aggregated user chat feedback counts.
|
|
1799
2439
|
*
|
|
@@ -1817,16 +2457,29 @@ export declare class AiAnalyticsService {
|
|
|
1817
2457
|
* end_date (str): End date for filtering (YYYY-MM-DD) - required.
|
|
1818
2458
|
* mentor_id (str): Filter by mentor unique ID.
|
|
1819
2459
|
* aggregation (str): Time aggregation level (hourly, daily, weekly) - default: daily.
|
|
1820
|
-
* @param endDate End date for filtering (YYYY-MM-DD)
|
|
1821
|
-
* @param org
|
|
1822
|
-
* @param startDate Start date for filtering (YYYY-MM-DD)
|
|
1823
|
-
* @param userId
|
|
1824
|
-
* @param aggregation Time aggregation level (hourly, daily, weekly)
|
|
1825
|
-
* @param mentorId Filter by mentor unique ID
|
|
1826
2460
|
* @returns UserChatFeedbackCount
|
|
1827
2461
|
* @throws ApiError
|
|
1828
2462
|
*/
|
|
1829
|
-
static aiAnalyticsOrgsUsersUserFeedbackList(endDate
|
|
2463
|
+
static aiAnalyticsOrgsUsersUserFeedbackList({ endDate, org, startDate, userId, aggregation, mentorId, }: {
|
|
2464
|
+
/**
|
|
2465
|
+
* End date for filtering (YYYY-MM-DD)
|
|
2466
|
+
*/
|
|
2467
|
+
endDate: string;
|
|
2468
|
+
org: string;
|
|
2469
|
+
/**
|
|
2470
|
+
* Start date for filtering (YYYY-MM-DD)
|
|
2471
|
+
*/
|
|
2472
|
+
startDate: string;
|
|
2473
|
+
userId: string;
|
|
2474
|
+
/**
|
|
2475
|
+
* Time aggregation level (hourly, daily, weekly)
|
|
2476
|
+
*/
|
|
2477
|
+
aggregation?: 'daily' | 'hourly' | 'weekly';
|
|
2478
|
+
/**
|
|
2479
|
+
* Filter by mentor unique ID
|
|
2480
|
+
*/
|
|
2481
|
+
mentorId?: string;
|
|
2482
|
+
}): CancelablePromise<Array<UserChatFeedbackCount>>;
|
|
1830
2483
|
/**
|
|
1831
2484
|
* Retrieve comprehensive user metrics.
|
|
1832
2485
|
*
|
|
@@ -1851,14 +2504,16 @@ export declare class AiAnalyticsService {
|
|
|
1851
2504
|
*
|
|
1852
2505
|
* Query Parameters:
|
|
1853
2506
|
* mentor_id (str): Filter metrics by mentor unique ID.
|
|
1854
|
-
* @param org
|
|
1855
|
-
* @param userId
|
|
1856
|
-
* @param groupBy
|
|
1857
|
-
* @param mentorId Filter metrics by mentor unique ID
|
|
1858
2507
|
* @returns UserMetricsResponse
|
|
1859
2508
|
* @throws ApiError
|
|
1860
2509
|
*/
|
|
1861
|
-
static aiAnalyticsOrgsUsersUserMetricsRetrieve(org
|
|
2510
|
+
static aiAnalyticsOrgsUsersUserMetricsRetrieve({ org, userId, groupBy, mentorId, }: {
|
|
2511
|
+
org: string;
|
|
2512
|
+
groupBy?: string; /**
|
|
2513
|
+
* Filter metrics by mentor unique ID
|
|
2514
|
+
*/
|
|
2515
|
+
mentorId?: string;
|
|
2516
|
+
}): CancelablePromise<UserMetricsResponse>;
|
|
1862
2517
|
/**
|
|
1863
2518
|
* Retrieve user distribution data for pie charts.
|
|
1864
2519
|
*
|
|
@@ -1881,15 +2536,25 @@ export declare class AiAnalyticsService {
|
|
|
1881
2536
|
* start_date (str): Start date for filtering (YYYY-MM-DD) - required.
|
|
1882
2537
|
* end_date (str): End date for filtering (YYYY-MM-DD) - required.
|
|
1883
2538
|
* mentor_id (str): Filter by mentor unique ID.
|
|
1884
|
-
* @param endDate End date for filtering (YYYY-MM-DD)
|
|
1885
|
-
* @param org
|
|
1886
|
-
* @param startDate Start date for filtering (YYYY-MM-DD)
|
|
1887
|
-
* @param userId
|
|
1888
|
-
* @param mentorId Filter by mentor unique ID
|
|
1889
2539
|
* @returns PieChartData
|
|
1890
2540
|
* @throws ApiError
|
|
1891
2541
|
*/
|
|
1892
|
-
static aiAnalyticsOrgsUsersUserMetricsPieChartRetrieve(endDate
|
|
2542
|
+
static aiAnalyticsOrgsUsersUserMetricsPieChartRetrieve({ endDate, org, startDate, userId, mentorId, }: {
|
|
2543
|
+
/**
|
|
2544
|
+
* End date for filtering (YYYY-MM-DD)
|
|
2545
|
+
*/
|
|
2546
|
+
endDate: string;
|
|
2547
|
+
org: string;
|
|
2548
|
+
/**
|
|
2549
|
+
* Start date for filtering (YYYY-MM-DD)
|
|
2550
|
+
*/
|
|
2551
|
+
startDate: string;
|
|
2552
|
+
userId: string;
|
|
2553
|
+
/**
|
|
2554
|
+
* Filter by mentor unique ID
|
|
2555
|
+
*/
|
|
2556
|
+
mentorId?: string;
|
|
2557
|
+
}): CancelablePromise<PieChartData>;
|
|
1893
2558
|
/**
|
|
1894
2559
|
* Retrieve user sentiment distribution.
|
|
1895
2560
|
*
|
|
@@ -1910,15 +2575,22 @@ export declare class AiAnalyticsService {
|
|
|
1910
2575
|
* Query Parameters:
|
|
1911
2576
|
* start_date (str): Start date for filtering (YYYY-MM-DD) - required.
|
|
1912
2577
|
* end_date (str): End date for filtering (YYYY-MM-DD) - required.
|
|
1913
|
-
* @param endDate End date for filtering (YYYY-MM-DD)
|
|
1914
|
-
* @param org
|
|
1915
|
-
* @param startDate Start date for filtering (YYYY-MM-DD)
|
|
1916
|
-
* @param userId
|
|
1917
|
-
* @param groupBy
|
|
1918
2578
|
* @returns SentimentSummary
|
|
1919
2579
|
* @throws ApiError
|
|
1920
2580
|
*/
|
|
1921
|
-
static aiAnalyticsOrgsUsersUserSentimentRetrieve(endDate
|
|
2581
|
+
static aiAnalyticsOrgsUsersUserSentimentRetrieve({ endDate, org, startDate, userId, groupBy, }: {
|
|
2582
|
+
/**
|
|
2583
|
+
* End date for filtering (YYYY-MM-DD)
|
|
2584
|
+
*/
|
|
2585
|
+
endDate: string;
|
|
2586
|
+
org: string;
|
|
2587
|
+
/**
|
|
2588
|
+
* Start date for filtering (YYYY-MM-DD)
|
|
2589
|
+
*/
|
|
2590
|
+
startDate: string;
|
|
2591
|
+
userId: string;
|
|
2592
|
+
groupBy?: string;
|
|
2593
|
+
}): CancelablePromise<SentimentSummary>;
|
|
1922
2594
|
/**
|
|
1923
2595
|
* Get active user counts over time.
|
|
1924
2596
|
*
|
|
@@ -1936,18 +2608,34 @@ export declare class AiAnalyticsService {
|
|
|
1936
2608
|
* Default time range is the last 7 days if no dates are specified.
|
|
1937
2609
|
*
|
|
1938
2610
|
* An active user is defined as a user with any activity within the past 30 days.
|
|
1939
|
-
* @param org
|
|
1940
|
-
* @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
|
|
1941
|
-
* @param endDate end date. ISO 8601
|
|
1942
|
-
* @param format Format
|
|
1943
|
-
*
|
|
1944
|
-
* * `json` - json
|
|
1945
|
-
* @param includeMainPlatform Include main platform data
|
|
1946
|
-
* @param startDate start date. ISO 8601
|
|
1947
2611
|
* @returns OvertimeWithChangeInfo
|
|
1948
2612
|
* @throws ApiError
|
|
1949
2613
|
*/
|
|
1950
|
-
static aiAnalyticsOverviewOrgsActiveUsersRetrieve(org
|
|
2614
|
+
static aiAnalyticsOverviewOrgsActiveUsersRetrieve({ org, departmentId, endDate, format, includeMainPlatform, startDate, }: {
|
|
2615
|
+
org: string;
|
|
2616
|
+
/**
|
|
2617
|
+
* When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
|
|
2618
|
+
*/
|
|
2619
|
+
departmentId?: number;
|
|
2620
|
+
/**
|
|
2621
|
+
* end date. ISO 8601
|
|
2622
|
+
*/
|
|
2623
|
+
endDate?: string;
|
|
2624
|
+
/**
|
|
2625
|
+
* Format
|
|
2626
|
+
*
|
|
2627
|
+
* * `json` - json
|
|
2628
|
+
*/
|
|
2629
|
+
format?: 'json';
|
|
2630
|
+
/**
|
|
2631
|
+
* Include main platform data
|
|
2632
|
+
*/
|
|
2633
|
+
includeMainPlatform?: boolean;
|
|
2634
|
+
/**
|
|
2635
|
+
* start date. ISO 8601
|
|
2636
|
+
*/
|
|
2637
|
+
startDate?: string;
|
|
2638
|
+
}): CancelablePromise<OvertimeWithChangeInfo>;
|
|
1951
2639
|
/**
|
|
1952
2640
|
* Get average grade value for platform, course, or user.
|
|
1953
2641
|
*
|
|
@@ -1967,16 +2655,26 @@ export declare class AiAnalyticsService {
|
|
|
1967
2655
|
* Access Control:
|
|
1968
2656
|
* - Platform admins can access any grade data
|
|
1969
2657
|
* - Learners can access their own grade data
|
|
1970
|
-
* @param org
|
|
1971
|
-
* @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
|
|
1972
|
-
* @param format Format
|
|
1973
|
-
*
|
|
1974
|
-
* * `json` - json
|
|
1975
|
-
* @param includeMainPlatform Include main platform data
|
|
1976
2658
|
* @returns Average
|
|
1977
2659
|
* @throws ApiError
|
|
1978
2660
|
*/
|
|
1979
|
-
static aiAnalyticsOverviewOrgsAverageGradeRetrieve(org
|
|
2661
|
+
static aiAnalyticsOverviewOrgsAverageGradeRetrieve({ org, departmentId, format, includeMainPlatform, }: {
|
|
2662
|
+
org: string;
|
|
2663
|
+
/**
|
|
2664
|
+
* When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
|
|
2665
|
+
*/
|
|
2666
|
+
departmentId?: number;
|
|
2667
|
+
/**
|
|
2668
|
+
* Format
|
|
2669
|
+
*
|
|
2670
|
+
* * `json` - json
|
|
2671
|
+
*/
|
|
2672
|
+
format?: 'json';
|
|
2673
|
+
/**
|
|
2674
|
+
* Include main platform data
|
|
2675
|
+
*/
|
|
2676
|
+
includeMainPlatform?: boolean;
|
|
2677
|
+
}): CancelablePromise<Average>;
|
|
1980
2678
|
/**
|
|
1981
2679
|
* Get course completion summary metrics over time.
|
|
1982
2680
|
*
|
|
@@ -1996,18 +2694,34 @@ export declare class AiAnalyticsService {
|
|
|
1996
2694
|
* - Change metrics compared to previous periods
|
|
1997
2695
|
*
|
|
1998
2696
|
* Default time range is the last 7 days if no dates are specified.
|
|
1999
|
-
* @param org
|
|
2000
|
-
* @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
|
|
2001
|
-
* @param endDate end date. ISO 8601
|
|
2002
|
-
* @param format Format
|
|
2003
|
-
*
|
|
2004
|
-
* * `json` - json
|
|
2005
|
-
* @param includeMainPlatform Include main platform data
|
|
2006
|
-
* @param startDate start date. ISO 8601
|
|
2007
2697
|
* @returns CourseCompletionSummaryOvertime
|
|
2008
2698
|
* @throws ApiError
|
|
2009
2699
|
*/
|
|
2010
|
-
static aiAnalyticsOverviewOrgsCoursesCompletionsRetrieve(org
|
|
2700
|
+
static aiAnalyticsOverviewOrgsCoursesCompletionsRetrieve({ org, departmentId, endDate, format, includeMainPlatform, startDate, }: {
|
|
2701
|
+
org: string;
|
|
2702
|
+
/**
|
|
2703
|
+
* When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
|
|
2704
|
+
*/
|
|
2705
|
+
departmentId?: number;
|
|
2706
|
+
/**
|
|
2707
|
+
* end date. ISO 8601
|
|
2708
|
+
*/
|
|
2709
|
+
endDate?: string;
|
|
2710
|
+
/**
|
|
2711
|
+
* Format
|
|
2712
|
+
*
|
|
2713
|
+
* * `json` - json
|
|
2714
|
+
*/
|
|
2715
|
+
format?: 'json';
|
|
2716
|
+
/**
|
|
2717
|
+
* Include main platform data
|
|
2718
|
+
*/
|
|
2719
|
+
includeMainPlatform?: boolean;
|
|
2720
|
+
/**
|
|
2721
|
+
* start date. ISO 8601
|
|
2722
|
+
*/
|
|
2723
|
+
startDate?: string;
|
|
2724
|
+
}): CancelablePromise<CourseCompletionSummaryOvertime>;
|
|
2011
2725
|
/**
|
|
2012
2726
|
* List all learners on the platform with aggregated metrics.
|
|
2013
2727
|
*
|
|
@@ -2023,19 +2737,38 @@ export declare class AiAnalyticsService {
|
|
|
2023
2737
|
*
|
|
2024
2738
|
* Returns:
|
|
2025
2739
|
* A paginated list of learners with their associated metrics.
|
|
2026
|
-
* @param org
|
|
2027
|
-
* @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
|
|
2028
|
-
* @param format Format
|
|
2029
|
-
*
|
|
2030
|
-
* * `json` - json
|
|
2031
|
-
* @param includeMainPlatform Include main platform data
|
|
2032
|
-
* @param length Size of data to return
|
|
2033
|
-
* @param page Page offset
|
|
2034
|
-
* @param search Search string for learner
|
|
2035
2740
|
* @returns PerlearnerUserList
|
|
2036
2741
|
* @throws ApiError
|
|
2037
2742
|
*/
|
|
2038
|
-
static aiAnalyticsOverviewOrgsLearnersRetrieve(org
|
|
2743
|
+
static aiAnalyticsOverviewOrgsLearnersRetrieve({ org, departmentId, format, includeMainPlatform, length, page, search, }: {
|
|
2744
|
+
org: string;
|
|
2745
|
+
/**
|
|
2746
|
+
* When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
|
|
2747
|
+
*/
|
|
2748
|
+
departmentId?: number;
|
|
2749
|
+
/**
|
|
2750
|
+
* Format
|
|
2751
|
+
*
|
|
2752
|
+
* * `json` - json
|
|
2753
|
+
*/
|
|
2754
|
+
format?: 'json';
|
|
2755
|
+
/**
|
|
2756
|
+
* Include main platform data
|
|
2757
|
+
*/
|
|
2758
|
+
includeMainPlatform?: boolean;
|
|
2759
|
+
/**
|
|
2760
|
+
* Size of data to return
|
|
2761
|
+
*/
|
|
2762
|
+
length?: number;
|
|
2763
|
+
/**
|
|
2764
|
+
* Page offset
|
|
2765
|
+
*/
|
|
2766
|
+
page?: number;
|
|
2767
|
+
/**
|
|
2768
|
+
* Search string for learner
|
|
2769
|
+
*/
|
|
2770
|
+
search?: string;
|
|
2771
|
+
}): CancelablePromise<PerlearnerUserList>;
|
|
2039
2772
|
/**
|
|
2040
2773
|
* Get time spent statistics on a per-course basis.
|
|
2041
2774
|
*
|
|
@@ -2054,20 +2787,42 @@ export declare class AiAnalyticsService {
|
|
|
2054
2787
|
* - Total time spent (in seconds)
|
|
2055
2788
|
* - Formatted time spent (human-readable)
|
|
2056
2789
|
* - Percentage of total platform time
|
|
2057
|
-
* @param org
|
|
2058
|
-
* @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
|
|
2059
|
-
* @param endDate end date. ISO 8601
|
|
2060
|
-
* @param format Format
|
|
2061
|
-
*
|
|
2062
|
-
* * `json` - json
|
|
2063
|
-
* @param includeMainPlatform Include main platform data
|
|
2064
|
-
* @param length Size of data to return
|
|
2065
|
-
* @param page Page offset
|
|
2066
|
-
* @param startDate start date. ISO 8601
|
|
2067
2790
|
* @returns TimeSpentPerCourse
|
|
2068
2791
|
* @throws ApiError
|
|
2069
2792
|
*/
|
|
2070
|
-
static aiAnalyticsOverviewOrgsMostActiveCoursesRetrieve(org
|
|
2793
|
+
static aiAnalyticsOverviewOrgsMostActiveCoursesRetrieve({ org, departmentId, endDate, format, includeMainPlatform, length, page, startDate, }: {
|
|
2794
|
+
org: string;
|
|
2795
|
+
/**
|
|
2796
|
+
* When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
|
|
2797
|
+
*/
|
|
2798
|
+
departmentId?: number;
|
|
2799
|
+
/**
|
|
2800
|
+
* end date. ISO 8601
|
|
2801
|
+
*/
|
|
2802
|
+
endDate?: string;
|
|
2803
|
+
/**
|
|
2804
|
+
* Format
|
|
2805
|
+
*
|
|
2806
|
+
* * `json` - json
|
|
2807
|
+
*/
|
|
2808
|
+
format?: 'json';
|
|
2809
|
+
/**
|
|
2810
|
+
* Include main platform data
|
|
2811
|
+
*/
|
|
2812
|
+
includeMainPlatform?: boolean;
|
|
2813
|
+
/**
|
|
2814
|
+
* Size of data to return
|
|
2815
|
+
*/
|
|
2816
|
+
length?: number;
|
|
2817
|
+
/**
|
|
2818
|
+
* Page offset
|
|
2819
|
+
*/
|
|
2820
|
+
page?: number;
|
|
2821
|
+
/**
|
|
2822
|
+
* start date. ISO 8601
|
|
2823
|
+
*/
|
|
2824
|
+
startDate?: string;
|
|
2825
|
+
}): CancelablePromise<TimeSpentPerCourse>;
|
|
2071
2826
|
/**
|
|
2072
2827
|
* Get registered user counts over time.
|
|
2073
2828
|
*
|
|
@@ -2083,18 +2838,34 @@ export declare class AiAnalyticsService {
|
|
|
2083
2838
|
* compared to previous periods.
|
|
2084
2839
|
*
|
|
2085
2840
|
* Default time range is the last 7 days if no dates are specified.
|
|
2086
|
-
* @param org
|
|
2087
|
-
* @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
|
|
2088
|
-
* @param endDate end date. ISO 8601
|
|
2089
|
-
* @param format Format
|
|
2090
|
-
*
|
|
2091
|
-
* * `json` - json
|
|
2092
|
-
* @param includeMainPlatform Include main platform data
|
|
2093
|
-
* @param startDate start date. ISO 8601
|
|
2094
2841
|
* @returns OvertimeWithChangeInfo
|
|
2095
2842
|
* @throws ApiError
|
|
2096
2843
|
*/
|
|
2097
|
-
static aiAnalyticsOverviewOrgsRegisteredUsersRetrieve(org
|
|
2844
|
+
static aiAnalyticsOverviewOrgsRegisteredUsersRetrieve({ org, departmentId, endDate, format, includeMainPlatform, startDate, }: {
|
|
2845
|
+
org: string;
|
|
2846
|
+
/**
|
|
2847
|
+
* When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
|
|
2848
|
+
*/
|
|
2849
|
+
departmentId?: number;
|
|
2850
|
+
/**
|
|
2851
|
+
* end date. ISO 8601
|
|
2852
|
+
*/
|
|
2853
|
+
endDate?: string;
|
|
2854
|
+
/**
|
|
2855
|
+
* Format
|
|
2856
|
+
*
|
|
2857
|
+
* * `json` - json
|
|
2858
|
+
*/
|
|
2859
|
+
format?: 'json';
|
|
2860
|
+
/**
|
|
2861
|
+
* Include main platform data
|
|
2862
|
+
*/
|
|
2863
|
+
includeMainPlatform?: boolean;
|
|
2864
|
+
/**
|
|
2865
|
+
* start date. ISO 8601
|
|
2866
|
+
*/
|
|
2867
|
+
startDate?: string;
|
|
2868
|
+
}): CancelablePromise<OvertimeWithChangeInfo>;
|
|
2098
2869
|
/**
|
|
2099
2870
|
* Get average grade value for platform, course, or user.
|
|
2100
2871
|
*
|
|
@@ -2114,17 +2885,27 @@ export declare class AiAnalyticsService {
|
|
|
2114
2885
|
* Access Control:
|
|
2115
2886
|
* - Platform admins can access any grade data
|
|
2116
2887
|
* - Learners can access their own grade data
|
|
2117
|
-
* @param courseId
|
|
2118
|
-
* @param org
|
|
2119
|
-
* @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
|
|
2120
|
-
* @param format Format
|
|
2121
|
-
*
|
|
2122
|
-
* * `json` - json
|
|
2123
|
-
* @param includeMainPlatform Include main platform data
|
|
2124
2888
|
* @returns Average
|
|
2125
2889
|
* @throws ApiError
|
|
2126
2890
|
*/
|
|
2127
|
-
static aiAnalyticsPerformanceOrgsCoursesGradingAverageRetrieve(courseId
|
|
2891
|
+
static aiAnalyticsPerformanceOrgsCoursesGradingAverageRetrieve({ courseId, org, departmentId, format, includeMainPlatform, }: {
|
|
2892
|
+
courseId: string;
|
|
2893
|
+
org: string;
|
|
2894
|
+
/**
|
|
2895
|
+
* When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
|
|
2896
|
+
*/
|
|
2897
|
+
departmentId?: number;
|
|
2898
|
+
/**
|
|
2899
|
+
* Format
|
|
2900
|
+
*
|
|
2901
|
+
* * `json` - json
|
|
2902
|
+
*/
|
|
2903
|
+
format?: 'json';
|
|
2904
|
+
/**
|
|
2905
|
+
* Include main platform data
|
|
2906
|
+
*/
|
|
2907
|
+
includeMainPlatform?: boolean;
|
|
2908
|
+
}): CancelablePromise<Average>;
|
|
2128
2909
|
/**
|
|
2129
2910
|
* Returns average course grade and grade cuttoff
|
|
2130
2911
|
*
|
|
@@ -2144,49 +2925,79 @@ export declare class AiAnalyticsService {
|
|
|
2144
2925
|
*
|
|
2145
2926
|
* Kwargs
|
|
2146
2927
|
* course_id
|
|
2147
|
-
* @param courseId
|
|
2148
|
-
* @param org
|
|
2149
|
-
* @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
|
|
2150
|
-
* @param format Format
|
|
2151
|
-
*
|
|
2152
|
-
* * `json` - json
|
|
2153
|
-
* @param includeMainPlatform Include main platform data
|
|
2154
2928
|
* @returns AvgCourseGradeWithCutoff
|
|
2155
2929
|
* @throws ApiError
|
|
2156
2930
|
*/
|
|
2157
|
-
static aiAnalyticsPerformanceOrgsCoursesGradingAverageWithCutoffRetrieve(courseId
|
|
2931
|
+
static aiAnalyticsPerformanceOrgsCoursesGradingAverageWithCutoffRetrieve({ courseId, org, departmentId, format, includeMainPlatform, }: {
|
|
2932
|
+
courseId: string;
|
|
2933
|
+
org: string;
|
|
2934
|
+
/**
|
|
2935
|
+
* When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
|
|
2936
|
+
*/
|
|
2937
|
+
departmentId?: number;
|
|
2938
|
+
/**
|
|
2939
|
+
* Format
|
|
2940
|
+
*
|
|
2941
|
+
* * `json` - json
|
|
2942
|
+
*/
|
|
2943
|
+
format?: 'json';
|
|
2944
|
+
/**
|
|
2945
|
+
* Include main platform data
|
|
2946
|
+
*/
|
|
2947
|
+
includeMainPlatform?: boolean;
|
|
2948
|
+
}): CancelablePromise<AvgCourseGradeWithCutoff>;
|
|
2158
2949
|
/**
|
|
2159
2950
|
* Grading summary for the entire course overview in a tree-like format
|
|
2160
2951
|
*
|
|
2161
2952
|
* Kwargs
|
|
2162
2953
|
* course_id <required>
|
|
2163
|
-
* @param courseId
|
|
2164
|
-
* @param org
|
|
2165
|
-
* @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
|
|
2166
|
-
* @param format Format
|
|
2167
|
-
*
|
|
2168
|
-
* * `json` - json
|
|
2169
|
-
* @param includeMainPlatform Include main platform data
|
|
2170
2954
|
* @returns CourseGradingDetail
|
|
2171
2955
|
* @throws ApiError
|
|
2172
2956
|
*/
|
|
2173
|
-
static aiAnalyticsPerformanceOrgsCoursesGradingDetailRetrieve(courseId
|
|
2957
|
+
static aiAnalyticsPerformanceOrgsCoursesGradingDetailRetrieve({ courseId, org, departmentId, format, includeMainPlatform, }: {
|
|
2958
|
+
courseId: string;
|
|
2959
|
+
org: string;
|
|
2960
|
+
/**
|
|
2961
|
+
* When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
|
|
2962
|
+
*/
|
|
2963
|
+
departmentId?: number;
|
|
2964
|
+
/**
|
|
2965
|
+
* Format
|
|
2966
|
+
*
|
|
2967
|
+
* * `json` - json
|
|
2968
|
+
*/
|
|
2969
|
+
format?: 'json';
|
|
2970
|
+
/**
|
|
2971
|
+
* Include main platform data
|
|
2972
|
+
*/
|
|
2973
|
+
includeMainPlatform?: boolean;
|
|
2974
|
+
}): CancelablePromise<CourseGradingDetail>;
|
|
2174
2975
|
/**
|
|
2175
2976
|
* Grading information per enrolled user in a course
|
|
2176
2977
|
*
|
|
2177
2978
|
* Kwargs
|
|
2178
2979
|
* course_id <required>
|
|
2179
|
-
* @param courseId
|
|
2180
|
-
* @param org
|
|
2181
|
-
* @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
|
|
2182
|
-
* @param format Format
|
|
2183
|
-
*
|
|
2184
|
-
* * `json` - json
|
|
2185
|
-
* @param includeMainPlatform Include main platform data
|
|
2186
2980
|
* @returns GradingPerUser
|
|
2187
2981
|
* @throws ApiError
|
|
2188
2982
|
*/
|
|
2189
|
-
static aiAnalyticsPerformanceOrgsCoursesGradingPerLearnerRetrieve(courseId
|
|
2983
|
+
static aiAnalyticsPerformanceOrgsCoursesGradingPerLearnerRetrieve({ courseId, org, departmentId, format, includeMainPlatform, }: {
|
|
2984
|
+
courseId: string;
|
|
2985
|
+
org: string;
|
|
2986
|
+
/**
|
|
2987
|
+
* When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
|
|
2988
|
+
*/
|
|
2989
|
+
departmentId?: number;
|
|
2990
|
+
/**
|
|
2991
|
+
* Format
|
|
2992
|
+
*
|
|
2993
|
+
* * `json` - json
|
|
2994
|
+
*/
|
|
2995
|
+
format?: 'json';
|
|
2996
|
+
/**
|
|
2997
|
+
* Include main platform data
|
|
2998
|
+
*/
|
|
2999
|
+
includeMainPlatform?: boolean;
|
|
3000
|
+
}): CancelablePromise<GradingPerUser>;
|
|
2190
3001
|
/**
|
|
2191
3002
|
* Returns average grades across various assignment types in a course
|
|
2192
3003
|
*
|
|
@@ -2205,17 +3016,27 @@ export declare class AiAnalyticsService {
|
|
|
2205
3016
|
* }, ...
|
|
2206
3017
|
* ]
|
|
2207
3018
|
* }
|
|
2208
|
-
* @param courseId
|
|
2209
|
-
* @param org
|
|
2210
|
-
* @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
|
|
2211
|
-
* @param format Format
|
|
2212
|
-
*
|
|
2213
|
-
* * `json` - json
|
|
2214
|
-
* @param includeMainPlatform Include main platform data
|
|
2215
3019
|
* @returns CourseGradeSummary
|
|
2216
3020
|
* @throws ApiError
|
|
2217
3021
|
*/
|
|
2218
|
-
static aiAnalyticsPerformanceOrgsCoursesGradingSummaryRetrieve(courseId
|
|
3022
|
+
static aiAnalyticsPerformanceOrgsCoursesGradingSummaryRetrieve({ courseId, org, departmentId, format, includeMainPlatform, }: {
|
|
3023
|
+
courseId: string;
|
|
3024
|
+
org: string;
|
|
3025
|
+
/**
|
|
3026
|
+
* When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
|
|
3027
|
+
*/
|
|
3028
|
+
departmentId?: number;
|
|
3029
|
+
/**
|
|
3030
|
+
* Format
|
|
3031
|
+
*
|
|
3032
|
+
* * `json` - json
|
|
3033
|
+
*/
|
|
3034
|
+
format?: 'json';
|
|
3035
|
+
/**
|
|
3036
|
+
* Include main platform data
|
|
3037
|
+
*/
|
|
3038
|
+
includeMainPlatform?: boolean;
|
|
3039
|
+
}): CancelablePromise<CourseGradeSummary>;
|
|
2219
3040
|
/**
|
|
2220
3041
|
* Get average grade value for platform, course, or user.
|
|
2221
3042
|
*
|
|
@@ -2235,16 +3056,26 @@ export declare class AiAnalyticsService {
|
|
|
2235
3056
|
* Access Control:
|
|
2236
3057
|
* - Platform admins can access any grade data
|
|
2237
3058
|
* - Learners can access their own grade data
|
|
2238
|
-
* @param org
|
|
2239
|
-
* @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
|
|
2240
|
-
* @param format Format
|
|
2241
|
-
*
|
|
2242
|
-
* * `json` - json
|
|
2243
|
-
* @param includeMainPlatform Include main platform data
|
|
2244
3059
|
* @returns Average
|
|
2245
3060
|
* @throws ApiError
|
|
2246
3061
|
*/
|
|
2247
|
-
static aiAnalyticsPerformanceOrgsGradingAverageRetrieve(org
|
|
3062
|
+
static aiAnalyticsPerformanceOrgsGradingAverageRetrieve({ org, departmentId, format, includeMainPlatform, }: {
|
|
3063
|
+
org: string;
|
|
3064
|
+
/**
|
|
3065
|
+
* When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
|
|
3066
|
+
*/
|
|
3067
|
+
departmentId?: number;
|
|
3068
|
+
/**
|
|
3069
|
+
* Format
|
|
3070
|
+
*
|
|
3071
|
+
* * `json` - json
|
|
3072
|
+
*/
|
|
3073
|
+
format?: 'json';
|
|
3074
|
+
/**
|
|
3075
|
+
* Include main platform data
|
|
3076
|
+
*/
|
|
3077
|
+
includeMainPlatform?: boolean;
|
|
3078
|
+
}): CancelablePromise<Average>;
|
|
2248
3079
|
/**
|
|
2249
3080
|
* List grade-related performance data for all courses.
|
|
2250
3081
|
*
|
|
@@ -2257,18 +3088,34 @@ export declare class AiAnalyticsService {
|
|
|
2257
3088
|
* - Enrollment count
|
|
2258
3089
|
* - Number of students who passed
|
|
2259
3090
|
* - Average grade
|
|
2260
|
-
* @param org
|
|
2261
|
-
* @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
|
|
2262
|
-
* @param format Format
|
|
2263
|
-
*
|
|
2264
|
-
* * `json` - json
|
|
2265
|
-
* @param includeMainPlatform Include main platform data
|
|
2266
|
-
* @param length Size of data to return
|
|
2267
|
-
* @param page Page offset
|
|
2268
3091
|
* @returns PerformanceGradesPerCourse
|
|
2269
3092
|
* @throws ApiError
|
|
2270
3093
|
*/
|
|
2271
|
-
static aiAnalyticsPerformanceOrgsGradingPerCourseRetrieve(org
|
|
3094
|
+
static aiAnalyticsPerformanceOrgsGradingPerCourseRetrieve({ org, departmentId, format, includeMainPlatform, length, page, }: {
|
|
3095
|
+
org: string;
|
|
3096
|
+
/**
|
|
3097
|
+
* When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
|
|
3098
|
+
*/
|
|
3099
|
+
departmentId?: number;
|
|
3100
|
+
/**
|
|
3101
|
+
* Format
|
|
3102
|
+
*
|
|
3103
|
+
* * `json` - json
|
|
3104
|
+
*/
|
|
3105
|
+
format?: 'json';
|
|
3106
|
+
/**
|
|
3107
|
+
* Include main platform data
|
|
3108
|
+
*/
|
|
3109
|
+
includeMainPlatform?: boolean;
|
|
3110
|
+
/**
|
|
3111
|
+
* Size of data to return
|
|
3112
|
+
*/
|
|
3113
|
+
length?: number;
|
|
3114
|
+
/**
|
|
3115
|
+
* Page offset
|
|
3116
|
+
*/
|
|
3117
|
+
page?: number;
|
|
3118
|
+
}): CancelablePromise<PerformanceGradesPerCourse>;
|
|
2272
3119
|
/**
|
|
2273
3120
|
* Enhanced API endpoint for listing learners with comprehensive filtering.
|
|
2274
3121
|
*
|
|
@@ -2298,25 +3145,62 @@ export declare class AiAnalyticsService {
|
|
|
2298
3145
|
* Access Control:
|
|
2299
3146
|
* - Platform admins can see all learners
|
|
2300
3147
|
* - Department admins can only see learners in their departments
|
|
2301
|
-
* @param org
|
|
2302
|
-
* @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
|
|
2303
|
-
* @param endDate Learner date_joined end date. ISO 8601
|
|
2304
|
-
* @param format Format
|
|
2305
|
-
*
|
|
2306
|
-
* * `json` - json
|
|
2307
|
-
* @param includeMainPlatform Include main platform data
|
|
2308
|
-
* @param isEnrolled Filter for users who have at least an enrollment
|
|
2309
|
-
* @param length Size of data to return
|
|
2310
|
-
* @param location Location search string
|
|
2311
|
-
* @param page Page offset
|
|
2312
|
-
* @param platform Platform search string
|
|
2313
|
-
* @param program Program search string
|
|
2314
|
-
* @param search Search string for learner. email, username or full name
|
|
2315
|
-
* @param startDate Learner date_joined start date. ISO 8601
|
|
2316
3148
|
* @returns NewPerLearnerList
|
|
2317
3149
|
* @throws ApiError
|
|
2318
3150
|
*/
|
|
2319
|
-
static aiAnalyticsPerlearnerOrgsLearnersRetrieve(org
|
|
3151
|
+
static aiAnalyticsPerlearnerOrgsLearnersRetrieve({ org, departmentId, endDate, format, includeMainPlatform, isEnrolled, length, location, page, platform, program, search, startDate, }: {
|
|
3152
|
+
org: string;
|
|
3153
|
+
/**
|
|
3154
|
+
* When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
|
|
3155
|
+
*/
|
|
3156
|
+
departmentId?: number;
|
|
3157
|
+
/**
|
|
3158
|
+
* Learner date_joined end date. ISO 8601
|
|
3159
|
+
*/
|
|
3160
|
+
endDate?: string;
|
|
3161
|
+
/**
|
|
3162
|
+
* Format
|
|
3163
|
+
*
|
|
3164
|
+
* * `json` - json
|
|
3165
|
+
*/
|
|
3166
|
+
format?: 'json';
|
|
3167
|
+
/**
|
|
3168
|
+
* Include main platform data
|
|
3169
|
+
*/
|
|
3170
|
+
includeMainPlatform?: boolean;
|
|
3171
|
+
/**
|
|
3172
|
+
* Filter for users who have at least an enrollment
|
|
3173
|
+
*/
|
|
3174
|
+
isEnrolled?: boolean | null;
|
|
3175
|
+
/**
|
|
3176
|
+
* Size of data to return
|
|
3177
|
+
*/
|
|
3178
|
+
length?: number;
|
|
3179
|
+
/**
|
|
3180
|
+
* Location search string
|
|
3181
|
+
*/
|
|
3182
|
+
location?: string;
|
|
3183
|
+
/**
|
|
3184
|
+
* Page offset
|
|
3185
|
+
*/
|
|
3186
|
+
page?: number;
|
|
3187
|
+
/**
|
|
3188
|
+
* Platform search string
|
|
3189
|
+
*/
|
|
3190
|
+
platform?: string;
|
|
3191
|
+
/**
|
|
3192
|
+
* Program search string
|
|
3193
|
+
*/
|
|
3194
|
+
program?: string;
|
|
3195
|
+
/**
|
|
3196
|
+
* Search string for learner. email, username or full name
|
|
3197
|
+
*/
|
|
3198
|
+
search?: string;
|
|
3199
|
+
/**
|
|
3200
|
+
* Learner date_joined start date. ISO 8601
|
|
3201
|
+
*/
|
|
3202
|
+
startDate?: string;
|
|
3203
|
+
}): CancelablePromise<NewPerLearnerList>;
|
|
2320
3204
|
/**
|
|
2321
3205
|
* List all learners on the platform with aggregated metrics.
|
|
2322
3206
|
*
|
|
@@ -2332,136 +3216,211 @@ export declare class AiAnalyticsService {
|
|
|
2332
3216
|
*
|
|
2333
3217
|
* Returns:
|
|
2334
3218
|
* A paginated list of learners with their associated metrics.
|
|
2335
|
-
* @param org
|
|
2336
|
-
* @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
|
|
2337
|
-
* @param format Format
|
|
2338
|
-
*
|
|
2339
|
-
* * `json` - json
|
|
2340
|
-
* @param includeMainPlatform Include main platform data
|
|
2341
|
-
* @param length Size of data to return
|
|
2342
|
-
* @param page Page offset
|
|
2343
|
-
* @param search Search string for learner
|
|
2344
3219
|
* @returns PerlearnerUserList
|
|
2345
3220
|
* @throws ApiError
|
|
2346
3221
|
*/
|
|
2347
|
-
static aiAnalyticsPerlearnerOrgsUsersRetrieve(org
|
|
3222
|
+
static aiAnalyticsPerlearnerOrgsUsersRetrieve({ org, departmentId, format, includeMainPlatform, length, page, search, }: {
|
|
3223
|
+
org: string;
|
|
3224
|
+
/**
|
|
3225
|
+
* When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
|
|
3226
|
+
*/
|
|
3227
|
+
departmentId?: number;
|
|
3228
|
+
/**
|
|
3229
|
+
* Format
|
|
3230
|
+
*
|
|
3231
|
+
* * `json` - json
|
|
3232
|
+
*/
|
|
3233
|
+
format?: 'json';
|
|
3234
|
+
/**
|
|
3235
|
+
* Include main platform data
|
|
3236
|
+
*/
|
|
3237
|
+
includeMainPlatform?: boolean;
|
|
3238
|
+
/**
|
|
3239
|
+
* Size of data to return
|
|
3240
|
+
*/
|
|
3241
|
+
length?: number;
|
|
3242
|
+
/**
|
|
3243
|
+
* Page offset
|
|
3244
|
+
*/
|
|
3245
|
+
page?: number;
|
|
3246
|
+
/**
|
|
3247
|
+
* Search string for learner
|
|
3248
|
+
*/
|
|
3249
|
+
search?: string;
|
|
3250
|
+
}): CancelablePromise<PerlearnerUserList>;
|
|
2348
3251
|
/**
|
|
2349
3252
|
* Provides information on user enrollments
|
|
2350
3253
|
*
|
|
2351
3254
|
* Params
|
|
2352
3255
|
* user_id e.g developer@ibleducation.com| developer
|
|
2353
|
-
* @param org
|
|
2354
|
-
* @param userId
|
|
2355
|
-
* @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
|
|
2356
|
-
* @param format Format
|
|
2357
|
-
*
|
|
2358
|
-
* * `json` - json
|
|
2359
|
-
* @param includeMainPlatform Include main platform data
|
|
2360
3256
|
* @returns ActivityAPI
|
|
2361
3257
|
* @throws ApiError
|
|
2362
3258
|
*/
|
|
2363
|
-
static aiAnalyticsPerlearnerOrgsUsersActivityRetrieve(org
|
|
3259
|
+
static aiAnalyticsPerlearnerOrgsUsersActivityRetrieve({ org, userId, departmentId, format, includeMainPlatform, }: {
|
|
3260
|
+
org: string; /**
|
|
3261
|
+
* When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
|
|
3262
|
+
*/
|
|
3263
|
+
departmentId?: number; /**
|
|
3264
|
+
* Format
|
|
3265
|
+
*
|
|
3266
|
+
* * `json` - json
|
|
3267
|
+
*/
|
|
3268
|
+
format?: 'json'; /**
|
|
3269
|
+
* Include main platform data
|
|
3270
|
+
*/
|
|
3271
|
+
includeMainPlatform?: boolean;
|
|
3272
|
+
}): CancelablePromise<ActivityAPI>;
|
|
2364
3273
|
/**
|
|
2365
3274
|
* Provides about a learner current grade in a course with the course cut
|
|
2366
3275
|
* Kwargs
|
|
2367
3276
|
* 1. course_id e.g course-v1:Org+Course4+Run
|
|
2368
3277
|
* 2. user_id e.g developer@ibleducation.com or dev123 (username|email)
|
|
2369
|
-
* @param courseId
|
|
2370
|
-
* @param org
|
|
2371
|
-
* @param userId
|
|
2372
|
-
* @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
|
|
2373
|
-
* @param endDate end date. ISO 8601
|
|
2374
|
-
* @param format Format
|
|
2375
|
-
*
|
|
2376
|
-
* * `json` - json
|
|
2377
|
-
* @param includeMainPlatform Include main platform data
|
|
2378
|
-
* @param startDate start date. ISO 8601
|
|
2379
3278
|
* @returns PerlearnerGradeWithCutOff
|
|
2380
3279
|
* @throws ApiError
|
|
2381
3280
|
*/
|
|
2382
|
-
static aiAnalyticsPerlearnerOrgsUsersCoursesGradingCutoffsRetrieve(courseId
|
|
3281
|
+
static aiAnalyticsPerlearnerOrgsUsersCoursesGradingCutoffsRetrieve({ courseId, org, userId, departmentId, endDate, format, includeMainPlatform, startDate, }: {
|
|
3282
|
+
courseId: string;
|
|
3283
|
+
org: string; /**
|
|
3284
|
+
* When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
|
|
3285
|
+
*/
|
|
3286
|
+
departmentId?: number; /**
|
|
3287
|
+
* end date. ISO 8601
|
|
3288
|
+
*/
|
|
3289
|
+
endDate?: string; /**
|
|
3290
|
+
* Format
|
|
3291
|
+
*
|
|
3292
|
+
* * `json` - json
|
|
3293
|
+
*/
|
|
3294
|
+
format?: 'json'; /**
|
|
3295
|
+
* Include main platform data
|
|
3296
|
+
*/
|
|
3297
|
+
includeMainPlatform?: boolean; /**
|
|
3298
|
+
* start date. ISO 8601
|
|
3299
|
+
*/
|
|
3300
|
+
startDate?: string;
|
|
3301
|
+
}): CancelablePromise<PerlearnerGradeWithCutOff>;
|
|
2383
3302
|
/**
|
|
2384
3303
|
* Mixin that includes the StudentTokenAuthentication and IsAdminUserOrStudent
|
|
2385
|
-
* @param courseId
|
|
2386
|
-
* @param org
|
|
2387
|
-
* @param userId
|
|
2388
|
-
* @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
|
|
2389
|
-
* @param endDate end date. ISO 8601
|
|
2390
|
-
* @param format Format
|
|
2391
|
-
*
|
|
2392
|
-
* * `json` - json
|
|
2393
|
-
* @param includeMainPlatform Include main platform data
|
|
2394
|
-
* @param startDate start date. ISO 8601
|
|
2395
3304
|
* @returns DetailedGradeView
|
|
2396
3305
|
* @throws ApiError
|
|
2397
3306
|
*/
|
|
2398
|
-
static aiAnalyticsPerlearnerOrgsUsersCoursesGradingDetailRetrieve(courseId
|
|
3307
|
+
static aiAnalyticsPerlearnerOrgsUsersCoursesGradingDetailRetrieve({ courseId, org, userId, departmentId, endDate, format, includeMainPlatform, startDate, }: {
|
|
3308
|
+
courseId: string;
|
|
3309
|
+
org: string; /**
|
|
3310
|
+
* When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
|
|
3311
|
+
*/
|
|
3312
|
+
departmentId?: number; /**
|
|
3313
|
+
* end date. ISO 8601
|
|
3314
|
+
*/
|
|
3315
|
+
endDate?: string; /**
|
|
3316
|
+
* Format
|
|
3317
|
+
*
|
|
3318
|
+
* * `json` - json
|
|
3319
|
+
*/
|
|
3320
|
+
format?: 'json'; /**
|
|
3321
|
+
* Include main platform data
|
|
3322
|
+
*/
|
|
3323
|
+
includeMainPlatform?: boolean; /**
|
|
3324
|
+
* start date. ISO 8601
|
|
3325
|
+
*/
|
|
3326
|
+
startDate?: string;
|
|
3327
|
+
}): CancelablePromise<DetailedGradeView>;
|
|
2399
3328
|
/**
|
|
2400
3329
|
* Query Params
|
|
2401
3330
|
* 1. course_id e.g course-v1:Org+Course4+Run
|
|
2402
3331
|
* 2. user_id e.g developer@ibleducation.com or dev123 (username|email)
|
|
2403
|
-
* @param courseId
|
|
2404
|
-
* @param org
|
|
2405
|
-
* @param userId
|
|
2406
|
-
* @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
|
|
2407
|
-
* @param endDate end date. ISO 8601
|
|
2408
|
-
* @param format Format
|
|
2409
|
-
*
|
|
2410
|
-
* * `json` - json
|
|
2411
|
-
* @param includeMainPlatform Include main platform data
|
|
2412
|
-
* @param startDate start date. ISO 8601
|
|
2413
3332
|
* @returns PerlearnerGradeSummary
|
|
2414
3333
|
* @throws ApiError
|
|
2415
3334
|
*/
|
|
2416
|
-
static aiAnalyticsPerlearnerOrgsUsersCoursesGradingSummaryRetrieve(courseId
|
|
3335
|
+
static aiAnalyticsPerlearnerOrgsUsersCoursesGradingSummaryRetrieve({ courseId, org, userId, departmentId, endDate, format, includeMainPlatform, startDate, }: {
|
|
3336
|
+
courseId: string;
|
|
3337
|
+
org: string; /**
|
|
3338
|
+
* When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
|
|
3339
|
+
*/
|
|
3340
|
+
departmentId?: number; /**
|
|
3341
|
+
* end date. ISO 8601
|
|
3342
|
+
*/
|
|
3343
|
+
endDate?: string; /**
|
|
3344
|
+
* Format
|
|
3345
|
+
*
|
|
3346
|
+
* * `json` - json
|
|
3347
|
+
*/
|
|
3348
|
+
format?: 'json'; /**
|
|
3349
|
+
* Include main platform data
|
|
3350
|
+
*/
|
|
3351
|
+
includeMainPlatform?: boolean; /**
|
|
3352
|
+
* start date. ISO 8601
|
|
3353
|
+
*/
|
|
3354
|
+
startDate?: string;
|
|
3355
|
+
}): CancelablePromise<PerlearnerGradeSummary>;
|
|
2417
3356
|
/**
|
|
2418
3357
|
* Average of days with atleast an activity within ENGAGEMENT_INDEX_PERIOD consecutive days for a learner in a course
|
|
2419
|
-
* @param courseId
|
|
2420
|
-
* @param org
|
|
2421
|
-
* @param userId
|
|
2422
3358
|
* @returns Value
|
|
2423
3359
|
* @throws ApiError
|
|
2424
3360
|
*/
|
|
2425
|
-
static aiAnalyticsPerlearnerOrgsUsersCoursesOverviewEngagementIndexRetrieve(courseId
|
|
3361
|
+
static aiAnalyticsPerlearnerOrgsUsersCoursesOverviewEngagementIndexRetrieve({ courseId, org, userId, }: {
|
|
3362
|
+
courseId: string;
|
|
3363
|
+
org: string;
|
|
3364
|
+
}): CancelablePromise<Value>;
|
|
2426
3365
|
/**
|
|
2427
3366
|
* Provides about a learner current grade in a course with the course cut
|
|
2428
3367
|
* Kwargs
|
|
2429
3368
|
* 1. course_id e.g course-v1:Org+Course4+Run
|
|
2430
3369
|
* 2. user_id e.g developer@ibleducation.com or dev123 (username|email)
|
|
2431
|
-
* @param courseId
|
|
2432
|
-
* @param org
|
|
2433
|
-
* @param userId
|
|
2434
|
-
* @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
|
|
2435
|
-
* @param endDate end date. ISO 8601
|
|
2436
|
-
* @param format Format
|
|
2437
|
-
*
|
|
2438
|
-
* * `json` - json
|
|
2439
|
-
* @param includeMainPlatform Include main platform data
|
|
2440
|
-
* @param startDate start date. ISO 8601
|
|
2441
3370
|
* @returns PerlearnerGradeWithCutOff
|
|
2442
3371
|
* @throws ApiError
|
|
2443
3372
|
*/
|
|
2444
|
-
static aiAnalyticsPerlearnerOrgsUsersCoursesOverviewGradeRetrieve(courseId
|
|
3373
|
+
static aiAnalyticsPerlearnerOrgsUsersCoursesOverviewGradeRetrieve({ courseId, org, userId, departmentId, endDate, format, includeMainPlatform, startDate, }: {
|
|
3374
|
+
courseId: string;
|
|
3375
|
+
org: string; /**
|
|
3376
|
+
* When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
|
|
3377
|
+
*/
|
|
3378
|
+
departmentId?: number; /**
|
|
3379
|
+
* end date. ISO 8601
|
|
3380
|
+
*/
|
|
3381
|
+
endDate?: string; /**
|
|
3382
|
+
* Format
|
|
3383
|
+
*
|
|
3384
|
+
* * `json` - json
|
|
3385
|
+
*/
|
|
3386
|
+
format?: 'json'; /**
|
|
3387
|
+
* Include main platform data
|
|
3388
|
+
*/
|
|
3389
|
+
includeMainPlatform?: boolean; /**
|
|
3390
|
+
* start date. ISO 8601
|
|
3391
|
+
*/
|
|
3392
|
+
startDate?: string;
|
|
3393
|
+
}): CancelablePromise<PerlearnerGradeWithCutOff>;
|
|
2445
3394
|
/**
|
|
2446
3395
|
* Evaluates performance index for platform, per course, per user and per user-per course
|
|
2447
3396
|
*
|
|
2448
3397
|
* Query Params
|
|
2449
3398
|
* course_id <optional>
|
|
2450
3399
|
* learner_id <optional>
|
|
2451
|
-
* @param courseId
|
|
2452
|
-
* @param org
|
|
2453
|
-
* @param userId
|
|
2454
|
-
* @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
|
|
2455
|
-
* @param endDate end date. ISO 8601
|
|
2456
|
-
* @param format Format
|
|
2457
|
-
*
|
|
2458
|
-
* * `json` - json
|
|
2459
|
-
* @param includeMainPlatform Include main platform data
|
|
2460
|
-
* @param startDate start date. ISO 8601
|
|
2461
3400
|
* @returns Value
|
|
2462
3401
|
* @throws ApiError
|
|
2463
3402
|
*/
|
|
2464
|
-
static aiAnalyticsPerlearnerOrgsUsersCoursesOverviewPerformanceIndexRetrieve(courseId
|
|
3403
|
+
static aiAnalyticsPerlearnerOrgsUsersCoursesOverviewPerformanceIndexRetrieve({ courseId, org, userId, departmentId, endDate, format, includeMainPlatform, startDate, }: {
|
|
3404
|
+
courseId: string;
|
|
3405
|
+
org: string; /**
|
|
3406
|
+
* When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
|
|
3407
|
+
*/
|
|
3408
|
+
departmentId?: number; /**
|
|
3409
|
+
* end date. ISO 8601
|
|
3410
|
+
*/
|
|
3411
|
+
endDate?: string; /**
|
|
3412
|
+
* Format
|
|
3413
|
+
*
|
|
3414
|
+
* * `json` - json
|
|
3415
|
+
*/
|
|
3416
|
+
format?: 'json'; /**
|
|
3417
|
+
* Include main platform data
|
|
3418
|
+
*/
|
|
3419
|
+
includeMainPlatform?: boolean; /**
|
|
3420
|
+
* start date. ISO 8601
|
|
3421
|
+
*/
|
|
3422
|
+
startDate?: string;
|
|
3423
|
+
}): CancelablePromise<Value>;
|
|
2465
3424
|
/**
|
|
2466
3425
|
* Time spent within a course in secs on a per-day basis
|
|
2467
3426
|
*
|
|
@@ -2473,20 +3432,30 @@ export declare class AiAnalyticsService {
|
|
|
2473
3432
|
* 4. end_date e.g 2020-10-10
|
|
2474
3433
|
*
|
|
2475
3434
|
* Default result when no query param is added is last_7_days (today inclusive)
|
|
2476
|
-
* @param courseId
|
|
2477
|
-
* @param org
|
|
2478
|
-
* @param userId
|
|
2479
|
-
* @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
|
|
2480
|
-
* @param endDate end date. ISO 8601
|
|
2481
|
-
* @param format Format
|
|
2482
|
-
*
|
|
2483
|
-
* * `json` - json
|
|
2484
|
-
* @param includeMainPlatform Include main platform data
|
|
2485
|
-
* @param startDate start date. ISO 8601
|
|
2486
3435
|
* @returns OverTimeWithTotal
|
|
2487
3436
|
* @throws ApiError
|
|
2488
3437
|
*/
|
|
2489
|
-
static aiAnalyticsPerlearnerOrgsUsersCoursesOverviewTimeOverTimeRetrieve(courseId
|
|
3438
|
+
static aiAnalyticsPerlearnerOrgsUsersCoursesOverviewTimeOverTimeRetrieve({ courseId, org, userId, departmentId, endDate, format, includeMainPlatform, startDate, }: {
|
|
3439
|
+
courseId: string;
|
|
3440
|
+
org: string; /**
|
|
3441
|
+
* When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
|
|
3442
|
+
*/
|
|
3443
|
+
departmentId?: number; /**
|
|
3444
|
+
* end date. ISO 8601
|
|
3445
|
+
*/
|
|
3446
|
+
endDate?: string; /**
|
|
3447
|
+
* Format
|
|
3448
|
+
*
|
|
3449
|
+
* * `json` - json
|
|
3450
|
+
*/
|
|
3451
|
+
format?: 'json'; /**
|
|
3452
|
+
* Include main platform data
|
|
3453
|
+
*/
|
|
3454
|
+
includeMainPlatform?: boolean; /**
|
|
3455
|
+
* start date. ISO 8601
|
|
3456
|
+
*/
|
|
3457
|
+
startDate?: string;
|
|
3458
|
+
}): CancelablePromise<OverTimeWithTotal>;
|
|
2490
3459
|
/**
|
|
2491
3460
|
* List of videos within a course a learner has watched
|
|
2492
3461
|
*
|
|
@@ -2495,18 +3464,24 @@ export declare class AiAnalyticsService {
|
|
|
2495
3464
|
* 2. user_id e.g developer@ibleducation.com or dev123 (username|email)
|
|
2496
3465
|
*
|
|
2497
3466
|
* Default result when no query param is added is [], 0
|
|
2498
|
-
* @param courseId
|
|
2499
|
-
* @param org
|
|
2500
|
-
* @param userId
|
|
2501
|
-
* @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
|
|
2502
|
-
* @param format Format
|
|
2503
|
-
*
|
|
2504
|
-
* * `json` - json
|
|
2505
|
-
* @param includeMainPlatform Include main platform data
|
|
2506
3467
|
* @returns PerLearnerCourseVideosWatched
|
|
2507
3468
|
* @throws ApiError
|
|
2508
3469
|
*/
|
|
2509
|
-
static aiAnalyticsPerlearnerOrgsUsersCoursesVideosRetrieve(courseId
|
|
3470
|
+
static aiAnalyticsPerlearnerOrgsUsersCoursesVideosRetrieve({ courseId, org, userId, departmentId, format, includeMainPlatform, }: {
|
|
3471
|
+
courseId: string;
|
|
3472
|
+
org: string; /**
|
|
3473
|
+
* When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
|
|
3474
|
+
*/
|
|
3475
|
+
departmentId?: number; /**
|
|
3476
|
+
* Format
|
|
3477
|
+
*
|
|
3478
|
+
* * `json` - json
|
|
3479
|
+
*/
|
|
3480
|
+
format?: 'json'; /**
|
|
3481
|
+
* Include main platform data
|
|
3482
|
+
*/
|
|
3483
|
+
includeMainPlatform?: boolean;
|
|
3484
|
+
}): CancelablePromise<PerLearnerCourseVideosWatched>;
|
|
2510
3485
|
/**
|
|
2511
3486
|
* Get video watch counts over time.
|
|
2512
3487
|
*
|
|
@@ -2527,36 +3502,52 @@ export declare class AiAnalyticsService {
|
|
|
2527
3502
|
* Access Control:
|
|
2528
3503
|
* - Platform admins can access any video watch data
|
|
2529
3504
|
* - Learners can access their own video watch data
|
|
2530
|
-
* @param courseId
|
|
2531
|
-
* @param org
|
|
2532
|
-
* @param userId
|
|
2533
|
-
* @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
|
|
2534
|
-
* @param endDate end date. ISO 8601
|
|
2535
|
-
* @param format Format
|
|
2536
|
-
*
|
|
2537
|
-
* * `json` - json
|
|
2538
|
-
* @param includeMainPlatform Include main platform data
|
|
2539
|
-
* @param startDate start date. ISO 8601
|
|
2540
3505
|
* @returns OverTimeWithTotal
|
|
2541
3506
|
* @throws ApiError
|
|
2542
3507
|
*/
|
|
2543
|
-
static aiAnalyticsPerlearnerOrgsUsersCoursesVideosOverTimeRetrieve(courseId
|
|
3508
|
+
static aiAnalyticsPerlearnerOrgsUsersCoursesVideosOverTimeRetrieve({ courseId, org, userId, departmentId, endDate, format, includeMainPlatform, startDate, }: {
|
|
3509
|
+
courseId: string;
|
|
3510
|
+
org: string; /**
|
|
3511
|
+
* When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
|
|
3512
|
+
*/
|
|
3513
|
+
departmentId?: number; /**
|
|
3514
|
+
* end date. ISO 8601
|
|
3515
|
+
*/
|
|
3516
|
+
endDate?: string; /**
|
|
3517
|
+
* Format
|
|
3518
|
+
*
|
|
3519
|
+
* * `json` - json
|
|
3520
|
+
*/
|
|
3521
|
+
format?: 'json'; /**
|
|
3522
|
+
* Include main platform data
|
|
3523
|
+
*/
|
|
3524
|
+
includeMainPlatform?: boolean; /**
|
|
3525
|
+
* start date. ISO 8601
|
|
3526
|
+
*/
|
|
3527
|
+
startDate?: string;
|
|
3528
|
+
}): CancelablePromise<OverTimeWithTotal>;
|
|
2544
3529
|
/**
|
|
2545
3530
|
* Summary Grading Information for a learner on a per-enrollment basis
|
|
2546
3531
|
*
|
|
2547
3532
|
* Query Params
|
|
2548
3533
|
* 1. user_id e.g developer@ibleducation.com or dev123 (username|email)
|
|
2549
|
-
* @param org
|
|
2550
|
-
* @param userId
|
|
2551
|
-
* @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
|
|
2552
|
-
* @param format Format
|
|
2553
|
-
*
|
|
2554
|
-
* * `json` - json
|
|
2555
|
-
* @param includeMainPlatform Include main platform data
|
|
2556
3534
|
* @returns PerlearnerGradingPerCourseAPI
|
|
2557
3535
|
* @throws ApiError
|
|
2558
3536
|
*/
|
|
2559
|
-
static aiAnalyticsPerlearnerOrgsUsersGradesPerCourseRetrieve(org
|
|
3537
|
+
static aiAnalyticsPerlearnerOrgsUsersGradesPerCourseRetrieve({ org, userId, departmentId, format, includeMainPlatform, }: {
|
|
3538
|
+
org: string; /**
|
|
3539
|
+
* When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
|
|
3540
|
+
*/
|
|
3541
|
+
departmentId?: number; /**
|
|
3542
|
+
* Format
|
|
3543
|
+
*
|
|
3544
|
+
* * `json` - json
|
|
3545
|
+
*/
|
|
3546
|
+
format?: 'json'; /**
|
|
3547
|
+
* Include main platform data
|
|
3548
|
+
*/
|
|
3549
|
+
includeMainPlatform?: boolean;
|
|
3550
|
+
}): CancelablePromise<PerlearnerGradingPerCourseAPI>;
|
|
2560
3551
|
/**
|
|
2561
3552
|
* Retrieve detailed information about a specific learner.
|
|
2562
3553
|
*
|
|
@@ -2580,56 +3571,80 @@ export declare class AiAnalyticsService {
|
|
|
2580
3571
|
* - Platform admins can access any learner
|
|
2581
3572
|
* - Learners can access their own information
|
|
2582
3573
|
* - Department admins can access learners in their departments
|
|
2583
|
-
* @param org
|
|
2584
|
-
* @param userId
|
|
2585
|
-
* @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
|
|
2586
|
-
* @param format Format
|
|
2587
|
-
*
|
|
2588
|
-
* * `json` - json
|
|
2589
|
-
* @param includeMainPlatform Include main platform data
|
|
2590
|
-
* @param meta Include extra analytics information?
|
|
2591
|
-
*
|
|
2592
|
-
* * `y` - y
|
|
2593
|
-
* * `yes` - yes
|
|
2594
|
-
* * `true` - true
|
|
2595
|
-
* * `True` - True
|
|
2596
|
-
* * `n` - n
|
|
2597
|
-
* * `no` - no
|
|
2598
|
-
* * `false` - false
|
|
2599
|
-
* * `False` - False
|
|
2600
|
-
* @param search
|
|
2601
3574
|
* @returns LearnerInformationAPI
|
|
2602
3575
|
* @throws ApiError
|
|
2603
3576
|
*/
|
|
2604
|
-
static aiAnalyticsPerlearnerOrgsUsersInfoRetrieve(org
|
|
3577
|
+
static aiAnalyticsPerlearnerOrgsUsersInfoRetrieve({ org, userId, departmentId, format, includeMainPlatform, meta, search, }: {
|
|
3578
|
+
org: string; /**
|
|
3579
|
+
* When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
|
|
3580
|
+
*/
|
|
3581
|
+
departmentId?: number; /**
|
|
3582
|
+
* Format
|
|
3583
|
+
*
|
|
3584
|
+
* * `json` - json
|
|
3585
|
+
*/
|
|
3586
|
+
format?: 'json'; /**
|
|
3587
|
+
* Include main platform data
|
|
3588
|
+
*/
|
|
3589
|
+
includeMainPlatform?: boolean; /**
|
|
3590
|
+
* Include extra analytics information?
|
|
3591
|
+
*
|
|
3592
|
+
* * `y` - y
|
|
3593
|
+
* * `yes` - yes
|
|
3594
|
+
* * `true` - true
|
|
3595
|
+
* * `True` - True
|
|
3596
|
+
* * `n` - n
|
|
3597
|
+
* * `no` - no
|
|
3598
|
+
* * `false` - false
|
|
3599
|
+
* * `False` - False
|
|
3600
|
+
*/
|
|
3601
|
+
meta?: 'y' | 'yes' | 'true' | 'True' | 'n' | 'no' | 'false' | 'False';
|
|
3602
|
+
search?: string;
|
|
3603
|
+
}): CancelablePromise<LearnerInformationAPI>;
|
|
2605
3604
|
/**
|
|
2606
3605
|
* Last course accessed by a learner, includes upto unit information as well
|
|
2607
|
-
* @param org
|
|
2608
|
-
* @param userId
|
|
2609
|
-
* @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
|
|
2610
|
-
* @param format Format
|
|
2611
|
-
*
|
|
2612
|
-
* * `json` - json
|
|
2613
|
-
* @param includeMainPlatform Include main platform data
|
|
2614
3606
|
* @returns PerLearnerLastAccess
|
|
2615
3607
|
* @throws ApiError
|
|
2616
3608
|
*/
|
|
2617
|
-
static aiAnalyticsPerlearnerOrgsUsersLastAccessRetrieve(org
|
|
3609
|
+
static aiAnalyticsPerlearnerOrgsUsersLastAccessRetrieve({ org, userId, departmentId, format, includeMainPlatform, }: {
|
|
3610
|
+
org: string; /**
|
|
3611
|
+
* When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
|
|
3612
|
+
*/
|
|
3613
|
+
departmentId?: number; /**
|
|
3614
|
+
* Format
|
|
3615
|
+
*
|
|
3616
|
+
* * `json` - json
|
|
3617
|
+
*/
|
|
3618
|
+
format?: 'json'; /**
|
|
3619
|
+
* Include main platform data
|
|
3620
|
+
*/
|
|
3621
|
+
includeMainPlatform?: boolean;
|
|
3622
|
+
}): CancelablePromise<PerLearnerLastAccess>;
|
|
2618
3623
|
/**
|
|
2619
3624
|
* Average of days with atleast an activity within ENGAGEMENT_INDEX_PERIOD consecutive days
|
|
2620
|
-
* @param org
|
|
2621
|
-
* @param userId
|
|
2622
|
-
* @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
|
|
2623
|
-
* @param endDate end date. ISO 8601
|
|
2624
|
-
* @param format Format
|
|
2625
|
-
*
|
|
2626
|
-
* * `json` - json
|
|
2627
|
-
* @param includeMainPlatform Include main platform data
|
|
2628
|
-
* @param startDate start date. ISO 8601
|
|
2629
3625
|
* @returns Value
|
|
2630
3626
|
* @throws ApiError
|
|
2631
3627
|
*/
|
|
2632
|
-
static aiAnalyticsPerlearnerOrgsUsersOverviewEngagementIndexRetrieve(org
|
|
3628
|
+
static aiAnalyticsPerlearnerOrgsUsersOverviewEngagementIndexRetrieve({ org, userId, departmentId, endDate, format, includeMainPlatform, startDate, }: {
|
|
3629
|
+
org: string; /**
|
|
3630
|
+
* When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
|
|
3631
|
+
*/
|
|
3632
|
+
departmentId?: number; /**
|
|
3633
|
+
* end date. ISO 8601
|
|
3634
|
+
*/
|
|
3635
|
+
endDate?: string; /**
|
|
3636
|
+
* Format
|
|
3637
|
+
*
|
|
3638
|
+
* * `json` - json
|
|
3639
|
+
*/
|
|
3640
|
+
format?: 'json'; /**
|
|
3641
|
+
* Include main platform data
|
|
3642
|
+
*/
|
|
3643
|
+
includeMainPlatform?: boolean; /**
|
|
3644
|
+
* start date. ISO 8601
|
|
3645
|
+
*/
|
|
3646
|
+
startDate?: string;
|
|
3647
|
+
}): CancelablePromise<Value>;
|
|
2633
3648
|
/**
|
|
2634
3649
|
* Get average grade value for platform, course, or user.
|
|
2635
3650
|
*
|
|
@@ -2649,36 +3664,52 @@ export declare class AiAnalyticsService {
|
|
|
2649
3664
|
* Access Control:
|
|
2650
3665
|
* - Platform admins can access any grade data
|
|
2651
3666
|
* - Learners can access their own grade data
|
|
2652
|
-
* @param org
|
|
2653
|
-
* @param userId
|
|
2654
|
-
* @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
|
|
2655
|
-
* @param format Format
|
|
2656
|
-
*
|
|
2657
|
-
* * `json` - json
|
|
2658
|
-
* @param includeMainPlatform Include main platform data
|
|
2659
3667
|
* @returns Average
|
|
2660
3668
|
* @throws ApiError
|
|
2661
3669
|
*/
|
|
2662
|
-
static aiAnalyticsPerlearnerOrgsUsersOverviewGradesAverageRetrieve(org
|
|
3670
|
+
static aiAnalyticsPerlearnerOrgsUsersOverviewGradesAverageRetrieve({ org, userId, departmentId, format, includeMainPlatform, }: {
|
|
3671
|
+
org: string; /**
|
|
3672
|
+
* When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
|
|
3673
|
+
*/
|
|
3674
|
+
departmentId?: number; /**
|
|
3675
|
+
* Format
|
|
3676
|
+
*
|
|
3677
|
+
* * `json` - json
|
|
3678
|
+
*/
|
|
3679
|
+
format?: 'json'; /**
|
|
3680
|
+
* Include main platform data
|
|
3681
|
+
*/
|
|
3682
|
+
includeMainPlatform?: boolean;
|
|
3683
|
+
}): CancelablePromise<Average>;
|
|
2663
3684
|
/**
|
|
2664
3685
|
* Evaluates performance index for platform, per course, per user and per user-per course
|
|
2665
3686
|
*
|
|
2666
3687
|
* Query Params
|
|
2667
3688
|
* course_id <optional>
|
|
2668
3689
|
* learner_id <optional>
|
|
2669
|
-
* @param org
|
|
2670
|
-
* @param userId
|
|
2671
|
-
* @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
|
|
2672
|
-
* @param endDate end date. ISO 8601
|
|
2673
|
-
* @param format Format
|
|
2674
|
-
*
|
|
2675
|
-
* * `json` - json
|
|
2676
|
-
* @param includeMainPlatform Include main platform data
|
|
2677
|
-
* @param startDate start date. ISO 8601
|
|
2678
3690
|
* @returns Value
|
|
2679
3691
|
* @throws ApiError
|
|
2680
3692
|
*/
|
|
2681
|
-
static aiAnalyticsPerlearnerOrgsUsersOverviewPerformanceIndexRetrieve(org
|
|
3693
|
+
static aiAnalyticsPerlearnerOrgsUsersOverviewPerformanceIndexRetrieve({ org, userId, departmentId, endDate, format, includeMainPlatform, startDate, }: {
|
|
3694
|
+
org: string; /**
|
|
3695
|
+
* When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
|
|
3696
|
+
*/
|
|
3697
|
+
departmentId?: number; /**
|
|
3698
|
+
* end date. ISO 8601
|
|
3699
|
+
*/
|
|
3700
|
+
endDate?: string; /**
|
|
3701
|
+
* Format
|
|
3702
|
+
*
|
|
3703
|
+
* * `json` - json
|
|
3704
|
+
*/
|
|
3705
|
+
format?: 'json'; /**
|
|
3706
|
+
* Include main platform data
|
|
3707
|
+
*/
|
|
3708
|
+
includeMainPlatform?: boolean; /**
|
|
3709
|
+
* start date. ISO 8601
|
|
3710
|
+
*/
|
|
3711
|
+
startDate?: string;
|
|
3712
|
+
}): CancelablePromise<Value>;
|
|
2682
3713
|
/**
|
|
2683
3714
|
* Time spent in secs on a per-day basis
|
|
2684
3715
|
*
|
|
@@ -2689,19 +3720,29 @@ export declare class AiAnalyticsService {
|
|
|
2689
3720
|
* 4. end_date e.g 2020-10-10
|
|
2690
3721
|
*
|
|
2691
3722
|
* Default result when no query param is added is last_7_days (today inclusive)
|
|
2692
|
-
* @param org
|
|
2693
|
-
* @param userId
|
|
2694
|
-
* @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
|
|
2695
|
-
* @param endDate end date. ISO 8601
|
|
2696
|
-
* @param format Format
|
|
2697
|
-
*
|
|
2698
|
-
* * `json` - json
|
|
2699
|
-
* @param includeMainPlatform Include main platform data
|
|
2700
|
-
* @param startDate start date. ISO 8601
|
|
2701
3723
|
* @returns OverTimeWithTotal
|
|
2702
3724
|
* @throws ApiError
|
|
2703
3725
|
*/
|
|
2704
|
-
static aiAnalyticsPerlearnerOrgsUsersOverviewTimeOverTimeRetrieve(org
|
|
3726
|
+
static aiAnalyticsPerlearnerOrgsUsersOverviewTimeOverTimeRetrieve({ org, userId, departmentId, endDate, format, includeMainPlatform, startDate, }: {
|
|
3727
|
+
org: string; /**
|
|
3728
|
+
* When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
|
|
3729
|
+
*/
|
|
3730
|
+
departmentId?: number; /**
|
|
3731
|
+
* end date. ISO 8601
|
|
3732
|
+
*/
|
|
3733
|
+
endDate?: string; /**
|
|
3734
|
+
* Format
|
|
3735
|
+
*
|
|
3736
|
+
* * `json` - json
|
|
3737
|
+
*/
|
|
3738
|
+
format?: 'json'; /**
|
|
3739
|
+
* Include main platform data
|
|
3740
|
+
*/
|
|
3741
|
+
includeMainPlatform?: boolean; /**
|
|
3742
|
+
* start date. ISO 8601
|
|
3743
|
+
*/
|
|
3744
|
+
startDate?: string;
|
|
3745
|
+
}): CancelablePromise<OverTimeWithTotal>;
|
|
2705
3746
|
/**
|
|
2706
3747
|
* Get video watch counts over time.
|
|
2707
3748
|
*
|
|
@@ -2722,37 +3763,57 @@ export declare class AiAnalyticsService {
|
|
|
2722
3763
|
* Access Control:
|
|
2723
3764
|
* - Platform admins can access any video watch data
|
|
2724
3765
|
* - Learners can access their own video watch data
|
|
2725
|
-
* @param org
|
|
2726
|
-
* @param userId
|
|
2727
|
-
* @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
|
|
2728
|
-
* @param endDate end date. ISO 8601
|
|
2729
|
-
* @param format Format
|
|
2730
|
-
*
|
|
2731
|
-
* * `json` - json
|
|
2732
|
-
* @param includeMainPlatform Include main platform data
|
|
2733
|
-
* @param startDate start date. ISO 8601
|
|
2734
3766
|
* @returns OverTimeWithTotal
|
|
2735
3767
|
* @throws ApiError
|
|
2736
3768
|
*/
|
|
2737
|
-
static aiAnalyticsPerlearnerOrgsUsersVideosOverTimeRetrieve(org
|
|
3769
|
+
static aiAnalyticsPerlearnerOrgsUsersVideosOverTimeRetrieve({ org, userId, departmentId, endDate, format, includeMainPlatform, startDate, }: {
|
|
3770
|
+
org: string; /**
|
|
3771
|
+
* When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
|
|
3772
|
+
*/
|
|
3773
|
+
departmentId?: number; /**
|
|
3774
|
+
* end date. ISO 8601
|
|
3775
|
+
*/
|
|
3776
|
+
endDate?: string; /**
|
|
3777
|
+
* Format
|
|
3778
|
+
*
|
|
3779
|
+
* * `json` - json
|
|
3780
|
+
*/
|
|
3781
|
+
format?: 'json'; /**
|
|
3782
|
+
* Include main platform data
|
|
3783
|
+
*/
|
|
3784
|
+
includeMainPlatform?: boolean; /**
|
|
3785
|
+
* start date. ISO 8601
|
|
3786
|
+
*/
|
|
3787
|
+
startDate?: string;
|
|
3788
|
+
}): CancelablePromise<OverTimeWithTotal>;
|
|
2738
3789
|
/**
|
|
2739
3790
|
* Summary Videos watched data for a learner per enrollment
|
|
2740
3791
|
*
|
|
2741
3792
|
* Query Params
|
|
2742
3793
|
* 1. user_id e.g developer@ibleducation.com or dev123 (username|email)
|
|
2743
|
-
* @param org
|
|
2744
|
-
* @param userId
|
|
2745
|
-
* @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
|
|
2746
|
-
* @param endDate end date. ISO 8601
|
|
2747
|
-
* @param format Format
|
|
2748
|
-
*
|
|
2749
|
-
* * `json` - json
|
|
2750
|
-
* @param includeMainPlatform Include main platform data
|
|
2751
|
-
* @param startDate start date. ISO 8601
|
|
2752
3794
|
* @returns PerlearnerEngagementVideosWatchedPerCourse
|
|
2753
3795
|
* @throws ApiError
|
|
2754
3796
|
*/
|
|
2755
|
-
static aiAnalyticsPerlearnerOrgsUsersVideosPerCourseRetrieve(org
|
|
3797
|
+
static aiAnalyticsPerlearnerOrgsUsersVideosPerCourseRetrieve({ org, userId, departmentId, endDate, format, includeMainPlatform, startDate, }: {
|
|
3798
|
+
org: string; /**
|
|
3799
|
+
* When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
|
|
3800
|
+
*/
|
|
3801
|
+
departmentId?: number; /**
|
|
3802
|
+
* end date. ISO 8601
|
|
3803
|
+
*/
|
|
3804
|
+
endDate?: string; /**
|
|
3805
|
+
* Format
|
|
3806
|
+
*
|
|
3807
|
+
* * `json` - json
|
|
3808
|
+
*/
|
|
3809
|
+
format?: 'json'; /**
|
|
3810
|
+
* Include main platform data
|
|
3811
|
+
*/
|
|
3812
|
+
includeMainPlatform?: boolean; /**
|
|
3813
|
+
* start date. ISO 8601
|
|
3814
|
+
*/
|
|
3815
|
+
startDate?: string;
|
|
3816
|
+
}): CancelablePromise<PerlearnerEngagementVideosWatchedPerCourse>;
|
|
2756
3817
|
/**
|
|
2757
3818
|
* Get a list of user groups with metrics and filtering options.
|
|
2758
3819
|
*
|
|
@@ -2779,23 +3840,60 @@ export declare class AiAnalyticsService {
|
|
|
2779
3840
|
* Access Control:
|
|
2780
3841
|
* - Platform admins can see all groups
|
|
2781
3842
|
* - Department admins can only see groups in their departments
|
|
2782
|
-
* @param org
|
|
2783
|
-
* @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
|
|
2784
|
-
* @param endDate Filter by learners date_joined. Start date. ISO 8601
|
|
2785
|
-
* @param format Format
|
|
2786
|
-
*
|
|
2787
|
-
* * `json` - json
|
|
2788
|
-
* @param groups Groups search string. Single string or list of strings. e.g 'sample_group' or `['group', 'another group']`
|
|
2789
|
-
* @param includeMainPlatform Include main platform data
|
|
2790
|
-
* @param isEnrolled Filter for users who have at least an enrollment
|
|
2791
|
-
* @param length Size of data to return
|
|
2792
|
-
* @param location Location search string
|
|
2793
|
-
* @param page Page offset
|
|
2794
|
-
* @param pathway Pathway string
|
|
2795
|
-
* @param program Program search string
|
|
2796
|
-
* @param startDate Filter by learners date_joined. Start date. ISO 8601
|
|
2797
3843
|
* @returns GroupList
|
|
2798
3844
|
* @throws ApiError
|
|
2799
3845
|
*/
|
|
2800
|
-
static aiAnalyticsUserGroupsOrgsRetrieve(org
|
|
3846
|
+
static aiAnalyticsUserGroupsOrgsRetrieve({ org, departmentId, endDate, format, groups, includeMainPlatform, isEnrolled, length, location, page, pathway, program, startDate, }: {
|
|
3847
|
+
org: string;
|
|
3848
|
+
/**
|
|
3849
|
+
* When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
|
|
3850
|
+
*/
|
|
3851
|
+
departmentId?: number;
|
|
3852
|
+
/**
|
|
3853
|
+
* Filter by learners date_joined. Start date. ISO 8601
|
|
3854
|
+
*/
|
|
3855
|
+
endDate?: string;
|
|
3856
|
+
/**
|
|
3857
|
+
* Format
|
|
3858
|
+
*
|
|
3859
|
+
* * `json` - json
|
|
3860
|
+
*/
|
|
3861
|
+
format?: 'json';
|
|
3862
|
+
/**
|
|
3863
|
+
* Groups search string. Single string or list of strings. e.g 'sample_group' or `['group', 'another group']`
|
|
3864
|
+
*/
|
|
3865
|
+
groups?: Array<string>;
|
|
3866
|
+
/**
|
|
3867
|
+
* Include main platform data
|
|
3868
|
+
*/
|
|
3869
|
+
includeMainPlatform?: boolean;
|
|
3870
|
+
/**
|
|
3871
|
+
* Filter for users who have at least an enrollment
|
|
3872
|
+
*/
|
|
3873
|
+
isEnrolled?: boolean | null;
|
|
3874
|
+
/**
|
|
3875
|
+
* Size of data to return
|
|
3876
|
+
*/
|
|
3877
|
+
length?: number;
|
|
3878
|
+
/**
|
|
3879
|
+
* Location search string
|
|
3880
|
+
*/
|
|
3881
|
+
location?: string;
|
|
3882
|
+
/**
|
|
3883
|
+
* Page offset
|
|
3884
|
+
*/
|
|
3885
|
+
page?: number;
|
|
3886
|
+
/**
|
|
3887
|
+
* Pathway string
|
|
3888
|
+
*/
|
|
3889
|
+
pathway?: string;
|
|
3890
|
+
/**
|
|
3891
|
+
* Program search string
|
|
3892
|
+
*/
|
|
3893
|
+
program?: string;
|
|
3894
|
+
/**
|
|
3895
|
+
* Filter by learners date_joined. Start date. ISO 8601
|
|
3896
|
+
*/
|
|
3897
|
+
startDate?: string;
|
|
3898
|
+
}): CancelablePromise<GroupList>;
|
|
2801
3899
|
}
|