@iblai/iblai-api 3.50.0-ai → 3.50.0-core

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (590) hide show
  1. package/dist/index.cjs.js +11071 -26543
  2. package/dist/index.cjs.js.map +1 -1
  3. package/dist/index.esm.js +11072 -26537
  4. package/dist/index.esm.js.map +1 -1
  5. package/dist/index.umd.js +11071 -26543
  6. package/dist/index.umd.js.map +1 -1
  7. package/dist/types/index.d.ts +2 -287
  8. package/dist/types/models/{StripeCheckoutSessionRequestModeEnum.d.ts → ModeEnum.d.ts} +1 -1
  9. package/dist/types/models/NotificationSource.d.ts +2 -2
  10. package/dist/types/models/StripeCheckoutSessionRequest.d.ts +2 -2
  11. package/dist/types/models/{NotificationSourceTypeEnum.d.ts → TypeEnum.d.ts} +1 -1
  12. package/dist/types/services/SearchService.d.ts +0 -718
  13. package/package.json +1 -1
  14. package/src/core/OpenAPI.ts +1 -1
  15. package/src/index.ts +2 -287
  16. package/src/models/{StripeCheckoutSessionRequestModeEnum.ts → ModeEnum.ts} +1 -1
  17. package/src/models/NotificationSource.ts +2 -2
  18. package/src/models/StripeCheckoutSessionRequest.ts +2 -2
  19. package/src/models/{NotificationSourceTypeEnum.ts → TypeEnum.ts} +1 -1
  20. package/src/services/SearchService.ts +398 -1428
  21. package/dist/types/models/AIGeneratedImage.d.ts +0 -13
  22. package/dist/types/models/AIUserProfileMemoryRelation.d.ts +0 -4
  23. package/dist/types/models/AIUserProfileRequest.d.ts +0 -4
  24. package/dist/types/models/APITokenCost.d.ts +0 -14
  25. package/dist/types/models/AccessEnum.d.ts +0 -8
  26. package/dist/types/models/AlignMentorBubbleEnum.d.ts +0 -8
  27. package/dist/types/models/AnalyticsOverview.d.ts +0 -7
  28. package/dist/types/models/Answer.d.ts +0 -11
  29. package/dist/types/models/AssumedKnowledge.d.ts +0 -4
  30. package/dist/types/models/AssumedKnowledgeLevel.d.ts +0 -4
  31. package/dist/types/models/AudioToTextRequest.d.ts +0 -3
  32. package/dist/types/models/AudioToTextResponse.d.ts +0 -3
  33. package/dist/types/models/CallAuthenticationRequest.d.ts +0 -13
  34. package/dist/types/models/CallAuthenticationResponse.d.ts +0 -21
  35. package/dist/types/models/CallConfiguration.d.ts +0 -26
  36. package/dist/types/models/CallConfigurationModeEnum.d.ts +0 -8
  37. package/dist/types/models/ChatHistory.d.ts +0 -8
  38. package/dist/types/models/ChatHistoryFilterData.d.ts +0 -9
  39. package/dist/types/models/ChatHistoryFilterUser.d.ts +0 -5
  40. package/dist/types/models/ChatHistoryItem.d.ts +0 -5
  41. package/dist/types/models/ChatHistorySessionId.d.ts +0 -3
  42. package/dist/types/models/ChatSessionRequest.d.ts +0 -10
  43. package/dist/types/models/ChatSessionResponse.d.ts +0 -5
  44. package/dist/types/models/CheckDocumentTrainingStatus.d.ts +0 -10
  45. package/dist/types/models/ComponentBlock.d.ts +0 -9
  46. package/dist/types/models/ComponentBlockTypeEnum.d.ts +0 -8
  47. package/dist/types/models/ConversationMessage.d.ts +0 -11
  48. package/dist/types/models/ConversationRating.d.ts +0 -6
  49. package/dist/types/models/ConversationSummary.d.ts +0 -5
  50. package/dist/types/models/ConversationVolume.d.ts +0 -4
  51. package/dist/types/models/Conversations.d.ts +0 -28
  52. package/dist/types/models/Cost.d.ts +0 -3
  53. package/dist/types/models/CostPerTenant.d.ts +0 -6
  54. package/dist/types/models/CourseCreationTask.d.ts +0 -31
  55. package/dist/types/models/CourseCreationTaskFile.d.ts +0 -7
  56. package/dist/types/models/CourseCreationTaskStatusEnum.d.ts +0 -16
  57. package/dist/types/models/CredentialRequest.d.ts +0 -14
  58. package/dist/types/models/CrontabSchedule.d.ts +0 -22
  59. package/dist/types/models/CustomInstructionResponse.d.ts +0 -13
  60. package/dist/types/models/DateRange.d.ts +0 -4
  61. package/dist/types/models/Document.d.ts +0 -41
  62. package/dist/types/models/DocumentFacet.d.ts +0 -17
  63. package/dist/types/models/DocumentSearchResponse.d.ts +0 -35
  64. package/dist/types/models/DocumentSettingsResponse.d.ts +0 -3
  65. package/dist/types/models/EdxCourse.d.ts +0 -11
  66. package/dist/types/models/ElevenlabsCustomVoice.d.ts +0 -4
  67. package/dist/types/models/ElevenlabsCustomVoiceResponse.d.ts +0 -8
  68. package/dist/types/models/EmailPromptDetail.d.ts +0 -13
  69. package/dist/types/models/EmailPromptList.d.ts +0 -11
  70. package/dist/types/models/EmailPromptSummary.d.ts +0 -5
  71. package/dist/types/models/FreeUsageCount.d.ts +0 -3
  72. package/dist/types/models/FullCourse.d.ts +0 -13
  73. package/dist/types/models/GreetingMethodEnum.d.ts +0 -8
  74. package/dist/types/models/GuidedPromptsResponse.d.ts +0 -3
  75. package/dist/types/models/HeygenMarketingVideoDetail.d.ts +0 -8
  76. package/dist/types/models/HeygenMarketingVideoList.d.ts +0 -6
  77. package/dist/types/models/HeygenTemplateRequest.d.ts +0 -5
  78. package/dist/types/models/HeygenTemplateResponseSingle.d.ts +0 -6
  79. package/dist/types/models/HeygenVideoDetail.d.ts +0 -8
  80. package/dist/types/models/HeygenVideoRequest.d.ts +0 -5
  81. package/dist/types/models/IBLAIPlatformMeta.d.ts +0 -3
  82. package/dist/types/models/IBLAIPlatformMetaRequest.d.ts +0 -6
  83. package/dist/types/models/IBLAIPlatformMetaUpdateRequest.d.ts +0 -10
  84. package/dist/types/models/InputQuestion.d.ts +0 -6
  85. package/dist/types/models/IntegrationCredential.d.ts +0 -8
  86. package/dist/types/models/IntialQuestionAnswer.d.ts +0 -3
  87. package/dist/types/models/JobRun.d.ts +0 -11
  88. package/dist/types/models/KindEnum.d.ts +0 -10
  89. package/dist/types/models/LLMCredentialRequest.d.ts +0 -14
  90. package/dist/types/models/LLMCredentialResponse.d.ts +0 -8
  91. package/dist/types/models/LLMModelForTenant.d.ts +0 -6
  92. package/dist/types/models/LLMQuestion.d.ts +0 -15
  93. package/dist/types/models/LLMResponse.d.ts +0 -14
  94. package/dist/types/models/LLMTracesListResponse.d.ts +0 -5
  95. package/dist/types/models/LanguagesView.d.ts +0 -5
  96. package/dist/types/models/LinkCourseRequest.d.ts +0 -3
  97. package/dist/types/models/LinkCourseResponse.d.ts +0 -5
  98. package/dist/types/models/LlmProviderEnum.d.ts +0 -8
  99. package/dist/types/models/MCPServer.d.ts +0 -21
  100. package/dist/types/models/MemoryComponentData.d.ts +0 -5
  101. package/dist/types/models/MemoryComponentMemory.d.ts +0 -4
  102. package/dist/types/models/MemoryComponentMemoryDetail.d.ts +0 -8
  103. package/dist/types/models/MemoryComponentResponse.d.ts +0 -5
  104. package/dist/types/models/MemoryProgress.d.ts +0 -8
  105. package/dist/types/models/MemoryStatusRequestView.d.ts +0 -6
  106. package/dist/types/models/MemoryStatusView.d.ts +0 -6
  107. package/dist/types/models/Mentor.d.ts +0 -87
  108. package/dist/types/models/MentorAudience.d.ts +0 -5
  109. package/dist/types/models/MentorCategory.d.ts +0 -9
  110. package/dist/types/models/MentorCategoryCreate.d.ts +0 -11
  111. package/dist/types/models/MentorCategoryGroup.d.ts +0 -11
  112. package/dist/types/models/MentorCategoryGroupCreate.d.ts +0 -11
  113. package/dist/types/models/MentorCreate.d.ts +0 -84
  114. package/dist/types/models/MentorCustomVoice.d.ts +0 -4
  115. package/dist/types/models/MentorCustomVoiceResponse.d.ts +0 -4
  116. package/dist/types/models/MentorData.d.ts +0 -7
  117. package/dist/types/models/MentorDetailAnalytics.d.ts +0 -6
  118. package/dist/types/models/MentorEval.d.ts +0 -11
  119. package/dist/types/models/MentorEvalQuestion.d.ts +0 -5
  120. package/dist/types/models/MentorEvalQuestionRequest.d.ts +0 -4
  121. package/dist/types/models/MentorEvalReport.d.ts +0 -10
  122. package/dist/types/models/MentorEvalRequest.d.ts +0 -8
  123. package/dist/types/models/MentorFacet.d.ts +0 -17
  124. package/dist/types/models/MentorFork.d.ts +0 -5
  125. package/dist/types/models/MentorFromTemplateRequest.d.ts +0 -4
  126. package/dist/types/models/MentorFromTemplateWithSettingRequest.d.ts +0 -47
  127. package/dist/types/models/MentorMemorySettingsRequest.d.ts +0 -6
  128. package/dist/types/models/MentorMemorySettingsResponse.d.ts +0 -6
  129. package/dist/types/models/MentorMetadata.d.ts +0 -5
  130. package/dist/types/models/MentorScenario.d.ts +0 -6
  131. package/dist/types/models/MentorScenarioPrompt.d.ts +0 -5
  132. package/dist/types/models/MentorSearchResponse.d.ts +0 -35
  133. package/dist/types/models/MentorSession.d.ts +0 -4
  134. package/dist/types/models/MentorSettings.d.ts +0 -60
  135. package/dist/types/models/MentorSettingsPublic.d.ts +0 -46
  136. package/dist/types/models/MentorSettingsRequest.d.ts +0 -62
  137. package/dist/types/models/MentorVisibilityEnum.d.ts +0 -10
  138. package/dist/types/models/MentorWizard.d.ts +0 -4
  139. package/dist/types/models/MessageStatistics.d.ts +0 -5
  140. package/dist/types/models/MessageView.d.ts +0 -10
  141. package/dist/types/models/MessageViewRequest.d.ts +0 -7
  142. package/dist/types/models/MessageViewUpdatResponse.d.ts +0 -3
  143. package/dist/types/models/Metadata.d.ts +0 -5
  144. package/dist/types/models/MetricChange.d.ts +0 -4
  145. package/dist/types/models/ModelCost.d.ts +0 -4
  146. package/dist/types/models/ModerationLog.d.ts +0 -11
  147. package/dist/types/models/NoChatMessagesFound.d.ts +0 -3
  148. package/dist/types/models/NullEnum.d.ts +0 -1
  149. package/dist/types/models/PageContent.d.ts +0 -6
  150. package/dist/types/models/PaginatedAIGeneratedImageList.d.ts +0 -7
  151. package/dist/types/models/PaginatedConversationsList.d.ts +0 -7
  152. package/dist/types/models/PaginatedCourseCreationTaskFileList.d.ts +0 -7
  153. package/dist/types/models/PaginatedCourseCreationTaskList.d.ts +0 -7
  154. package/dist/types/models/PaginatedEdxCourseList.d.ts +0 -7
  155. package/dist/types/models/PaginatedEmailPromptListList.d.ts +0 -7
  156. package/dist/types/models/PaginatedHeygenMarketingVideoListList.d.ts +0 -7
  157. package/dist/types/models/PaginatedHeygenTemplateResponseSingleList.d.ts +0 -7
  158. package/dist/types/models/PaginatedJobRunList.d.ts +0 -7
  159. package/dist/types/models/PaginatedMCPServerList.d.ts +0 -7
  160. package/dist/types/models/PaginatedMentorList.d.ts +0 -7
  161. package/dist/types/models/PaginatedModerationLogList.d.ts +0 -7
  162. package/dist/types/models/PaginatedPeriodicAgentList.d.ts +0 -7
  163. package/dist/types/models/PaginatedPeriodicAgentLogList.d.ts +0 -7
  164. package/dist/types/models/PaginatedPlayWrightScriptList.d.ts +0 -7
  165. package/dist/types/models/PaginatedSectionList.d.ts +0 -7
  166. package/dist/types/models/PaginatedSubSectionList.d.ts +0 -7
  167. package/dist/types/models/PaginatedTopicStatisticsResponse.d.ts +0 -7
  168. package/dist/types/models/PaginatedUnitList.d.ts +0 -7
  169. package/dist/types/models/PaginatedUserEdxMemoryList.d.ts +0 -7
  170. package/dist/types/models/PaginatedVoiceList.d.ts +0 -7
  171. package/dist/types/models/PatchedCallConfiguration.d.ts +0 -26
  172. package/dist/types/models/PatchedConversations.d.ts +0 -28
  173. package/dist/types/models/PatchedCourseCreationTaskFile.d.ts +0 -7
  174. package/dist/types/models/PatchedCredentialRequest.d.ts +0 -14
  175. package/dist/types/models/PatchedLLMCredentialRequest.d.ts +0 -14
  176. package/dist/types/models/PatchedMCPServer.d.ts +0 -21
  177. package/dist/types/models/PatchedMentorCategoryGroupCreate.d.ts +0 -11
  178. package/dist/types/models/PatchedMentorCreate.d.ts +0 -84
  179. package/dist/types/models/PatchedPeriodicAgentCreate.d.ts +0 -41
  180. package/dist/types/models/PatchedPlayWrightScript.d.ts +0 -12
  181. package/dist/types/models/PatchedPrompt.d.ts +0 -22
  182. package/dist/types/models/PatchedSection.d.ts +0 -9
  183. package/dist/types/models/PatchedSubSection.d.ts +0 -9
  184. package/dist/types/models/PatchedUnit.d.ts +0 -11
  185. package/dist/types/models/PeriodicAgent.d.ts +0 -42
  186. package/dist/types/models/PeriodicAgentCreate.d.ts +0 -41
  187. package/dist/types/models/PeriodicAgentLog.d.ts +0 -11
  188. package/dist/types/models/PeriodicAgentLogStatusEnum.d.ts +0 -10
  189. package/dist/types/models/PeriodicTask.d.ts +0 -21
  190. package/dist/types/models/PieChartData.d.ts +0 -5
  191. package/dist/types/models/PieChartSegment.d.ts +0 -4
  192. package/dist/types/models/PinnedMessageCreate.d.ts +0 -9
  193. package/dist/types/models/PinnedMessageGet.d.ts +0 -7
  194. package/dist/types/models/PinnedMessageRequest.d.ts +0 -6
  195. package/dist/types/models/PlayWrightScript.d.ts +0 -12
  196. package/dist/types/models/PredictiveAnalyticsRequest.d.ts +0 -4
  197. package/dist/types/models/PredictiveAnalyticsResponse.d.ts +0 -4
  198. package/dist/types/models/PreviousAgentStatusEnum.d.ts +0 -12
  199. package/dist/types/models/Prompt.d.ts +0 -22
  200. package/dist/types/models/PromptCategory.d.ts +0 -7
  201. package/dist/types/models/PromptFacet.d.ts +0 -17
  202. package/dist/types/models/PromptSearchResponse.d.ts +0 -35
  203. package/dist/types/models/PromptVisibilityEnum.d.ts +0 -10
  204. package/dist/types/models/ProviderEnum.d.ts +0 -10
  205. package/dist/types/models/QuestionCardTag.d.ts +0 -8
  206. package/dist/types/models/QuestionRequest.d.ts +0 -15
  207. package/dist/types/models/QuestionResponse.d.ts +0 -10
  208. package/dist/types/models/RatingEnum.d.ts +0 -8
  209. package/dist/types/models/RatingRecord.d.ts +0 -4
  210. package/dist/types/models/RecentlyAccessedMentor.d.ts +0 -8
  211. package/dist/types/models/RecommendCourseBlock.d.ts +0 -3
  212. package/dist/types/models/RecommendCourseResponse.d.ts +0 -3
  213. package/dist/types/models/RecommendedCoursesResponse.d.ts +0 -33
  214. package/dist/types/models/RelatedText.d.ts +0 -3
  215. package/dist/types/models/RequestDataVariable.d.ts +0 -14
  216. package/dist/types/models/ResourceScrappedData.d.ts +0 -13
  217. package/dist/types/models/ResourceScrappedDataStatusEnum.d.ts +0 -12
  218. package/dist/types/models/ResponseDataVariable.d.ts +0 -14
  219. package/dist/types/models/RetreiverTrainViewRequest.d.ts +0 -10
  220. package/dist/types/models/RetreiverTrainViewResponse.d.ts +0 -6
  221. package/dist/types/models/RetrieveTask.d.ts +0 -3
  222. package/dist/types/models/RetrieverDocumentEmbedding.d.ts +0 -17
  223. package/dist/types/models/RetrieverDocumentEmbeddingRequest.d.ts +0 -30
  224. package/dist/types/models/RetrieverRequestSearch.d.ts +0 -10
  225. package/dist/types/models/RetrieverRequestSearchDocument.d.ts +0 -10
  226. package/dist/types/models/RetrieverResponseSearch.d.ts +0 -7
  227. package/dist/types/models/ReuestDataVariableList.d.ts +0 -4
  228. package/dist/types/models/RunMentorEval.d.ts +0 -3
  229. package/dist/types/models/ScanWebhookRequest.d.ts +0 -6
  230. package/dist/types/models/ScanWebhookResponse.d.ts +0 -3
  231. package/dist/types/models/Section.d.ts +0 -9
  232. package/dist/types/models/SectionWithChildren.d.ts +0 -11
  233. package/dist/types/models/SeedMentorsView.d.ts +0 -3
  234. package/dist/types/models/SentimentSummary.d.ts +0 -4
  235. package/dist/types/models/SessionBrowserScreenshot.d.ts +0 -8
  236. package/dist/types/models/SessionDetail.d.ts +0 -6
  237. package/dist/types/models/SessionMemoryStorage.d.ts +0 -6
  238. package/dist/types/models/ShellLogs.d.ts +0 -3
  239. package/dist/types/models/SpacedRepetitionLearningPath.d.ts +0 -3
  240. package/dist/types/models/SpacedRepetitionQuestionStats.d.ts +0 -5
  241. package/dist/types/models/StarMentor.d.ts +0 -7
  242. package/dist/types/models/Status6eeEnum.d.ts +0 -12
  243. package/dist/types/models/Step.d.ts +0 -9
  244. package/dist/types/models/StepStatusEnum.d.ts +0 -10
  245. package/dist/types/models/SttProviderEnum.d.ts +0 -12
  246. package/dist/types/models/StudentChatMessage.d.ts +0 -4
  247. package/dist/types/models/StylesView.d.ts +0 -4
  248. package/dist/types/models/SubSection.d.ts +0 -9
  249. package/dist/types/models/SubSectionWithChildren.d.ts +0 -11
  250. package/dist/types/models/TagsView.d.ts +0 -5
  251. package/dist/types/models/TargetSystemEnum.d.ts +0 -8
  252. package/dist/types/models/TaskView.d.ts +0 -3
  253. package/dist/types/models/TemplateMentor.d.ts +0 -9
  254. package/dist/types/models/TenantMentorTraces.d.ts +0 -6
  255. package/dist/types/models/ThemeEnum.d.ts +0 -8
  256. package/dist/types/models/TonesView.d.ts +0 -4
  257. package/dist/types/models/ToolResponse.d.ts +0 -11
  258. package/dist/types/models/TopicModel.d.ts +0 -3
  259. package/dist/types/models/TopicRecord.d.ts +0 -4
  260. package/dist/types/models/TopicStatistics.d.ts +0 -7
  261. package/dist/types/models/TopicStatisticsResponse.d.ts +0 -6
  262. package/dist/types/models/TopicSummaryView.d.ts +0 -4
  263. package/dist/types/models/TrainChatSessionDocumentView.d.ts +0 -6
  264. package/dist/types/models/TrainChatSessionDocumentViewRequest.d.ts +0 -6
  265. package/dist/types/models/TrainDocumentViewRequest.d.ts +0 -42
  266. package/dist/types/models/TrainDocumentViewResponse.d.ts +0 -15
  267. package/dist/types/models/TrainingStatusEnum.d.ts +0 -12
  268. package/dist/types/models/TransportEnum.d.ts +0 -8
  269. package/dist/types/models/TrendEntry.d.ts +0 -4
  270. package/dist/types/models/TriggerRequest.d.ts +0 -5
  271. package/dist/types/models/TriggerResponse.d.ts +0 -6
  272. package/dist/types/models/TtsProviderEnum.d.ts +0 -10
  273. package/dist/types/models/TypeC42Enum.d.ts +0 -8
  274. package/dist/types/models/Unit.d.ts +0 -11
  275. package/dist/types/models/UnitWithChildren.d.ts +0 -13
  276. package/dist/types/models/UseMainCreds.d.ts +0 -3
  277. package/dist/types/models/UserAllChatMemoryView.d.ts +0 -7
  278. package/dist/types/models/UserCatalogItemMemoryView.d.ts +0 -14
  279. package/dist/types/models/UserChatByPeriod.d.ts +0 -4
  280. package/dist/types/models/UserChatFeedback.d.ts +0 -14
  281. package/dist/types/models/UserChatFeedbackCount.d.ts +0 -4
  282. package/dist/types/models/UserChatMemoryStatusRequestView.d.ts +0 -6
  283. package/dist/types/models/UserChatMemoryStatusView.d.ts +0 -6
  284. package/dist/types/models/UserChatMemoryUpdateView.d.ts +0 -10
  285. package/dist/types/models/UserCountRecord.d.ts +0 -4
  286. package/dist/types/models/UserEdxMemory.d.ts +0 -15
  287. package/dist/types/models/UserMemoryContextRequest.d.ts +0 -13
  288. package/dist/types/models/UserMemoryContextResponse.d.ts +0 -12
  289. package/dist/types/models/UserMetric.d.ts +0 -4
  290. package/dist/types/models/UserMetricsResponse.d.ts +0 -7
  291. package/dist/types/models/UserSentimentCountView.d.ts +0 -4
  292. package/dist/types/models/UserTrendByPeriod.d.ts +0 -5
  293. package/dist/types/models/VectorResult.d.ts +0 -8
  294. package/dist/types/models/VideoCaption.d.ts +0 -3
  295. package/dist/types/models/Voice.d.ts +0 -9
  296. package/dist/types/models/WebResource.d.ts +0 -9
  297. package/dist/types/models/WebResourceCard.d.ts +0 -7
  298. package/dist/types/models/WebResourcesQuery.d.ts +0 -3
  299. package/dist/types/services/AiAccountService.d.ts +0 -319
  300. package/dist/types/services/AiAnalyticsService.d.ts +0 -3899
  301. package/dist/types/services/AiIndexService.d.ts +0 -407
  302. package/dist/types/services/AiMarketingService.d.ts +0 -38
  303. package/dist/types/services/AiMediaService.d.ts +0 -122
  304. package/dist/types/services/AiMentorService.d.ts +0 -4936
  305. package/dist/types/services/AiPromptService.d.ts +0 -1034
  306. package/src/models/AIGeneratedImage.ts +0 -18
  307. package/src/models/AIUserProfileMemoryRelation.ts +0 -9
  308. package/src/models/AIUserProfileRequest.ts +0 -9
  309. package/src/models/APITokenCost.ts +0 -19
  310. package/src/models/AccessEnum.ts +0 -12
  311. package/src/models/AlignMentorBubbleEnum.ts +0 -12
  312. package/src/models/AnalyticsOverview.ts +0 -12
  313. package/src/models/Answer.ts +0 -16
  314. package/src/models/AssumedKnowledge.ts +0 -9
  315. package/src/models/AssumedKnowledgeLevel.ts +0 -9
  316. package/src/models/AudioToTextRequest.ts +0 -8
  317. package/src/models/AudioToTextResponse.ts +0 -8
  318. package/src/models/CallAuthenticationRequest.ts +0 -18
  319. package/src/models/CallAuthenticationResponse.ts +0 -26
  320. package/src/models/CallConfiguration.ts +0 -31
  321. package/src/models/CallConfigurationModeEnum.ts +0 -12
  322. package/src/models/ChatHistory.ts +0 -13
  323. package/src/models/ChatHistoryFilterData.ts +0 -14
  324. package/src/models/ChatHistoryFilterUser.ts +0 -10
  325. package/src/models/ChatHistoryItem.ts +0 -10
  326. package/src/models/ChatHistorySessionId.ts +0 -8
  327. package/src/models/ChatSessionRequest.ts +0 -15
  328. package/src/models/ChatSessionResponse.ts +0 -10
  329. package/src/models/CheckDocumentTrainingStatus.ts +0 -15
  330. package/src/models/ComponentBlock.ts +0 -14
  331. package/src/models/ComponentBlockTypeEnum.ts +0 -12
  332. package/src/models/ConversationMessage.ts +0 -16
  333. package/src/models/ConversationRating.ts +0 -11
  334. package/src/models/ConversationSummary.ts +0 -10
  335. package/src/models/ConversationVolume.ts +0 -9
  336. package/src/models/Conversations.ts +0 -33
  337. package/src/models/Cost.ts +0 -8
  338. package/src/models/CostPerTenant.ts +0 -11
  339. package/src/models/CourseCreationTask.ts +0 -36
  340. package/src/models/CourseCreationTaskFile.ts +0 -12
  341. package/src/models/CourseCreationTaskStatusEnum.ts +0 -20
  342. package/src/models/CredentialRequest.ts +0 -19
  343. package/src/models/CrontabSchedule.ts +0 -27
  344. package/src/models/CustomInstructionResponse.ts +0 -18
  345. package/src/models/DateRange.ts +0 -9
  346. package/src/models/Document.ts +0 -46
  347. package/src/models/DocumentFacet.ts +0 -22
  348. package/src/models/DocumentSearchResponse.ts +0 -40
  349. package/src/models/DocumentSettingsResponse.ts +0 -8
  350. package/src/models/EdxCourse.ts +0 -16
  351. package/src/models/ElevenlabsCustomVoice.ts +0 -9
  352. package/src/models/ElevenlabsCustomVoiceResponse.ts +0 -13
  353. package/src/models/EmailPromptDetail.ts +0 -18
  354. package/src/models/EmailPromptList.ts +0 -16
  355. package/src/models/EmailPromptSummary.ts +0 -10
  356. package/src/models/FreeUsageCount.ts +0 -8
  357. package/src/models/FullCourse.ts +0 -18
  358. package/src/models/GreetingMethodEnum.ts +0 -12
  359. package/src/models/GuidedPromptsResponse.ts +0 -8
  360. package/src/models/HeygenMarketingVideoDetail.ts +0 -13
  361. package/src/models/HeygenMarketingVideoList.ts +0 -11
  362. package/src/models/HeygenTemplateRequest.ts +0 -10
  363. package/src/models/HeygenTemplateResponseSingle.ts +0 -11
  364. package/src/models/HeygenVideoDetail.ts +0 -13
  365. package/src/models/HeygenVideoRequest.ts +0 -10
  366. package/src/models/IBLAIPlatformMeta.ts +0 -8
  367. package/src/models/IBLAIPlatformMetaRequest.ts +0 -11
  368. package/src/models/IBLAIPlatformMetaUpdateRequest.ts +0 -15
  369. package/src/models/InputQuestion.ts +0 -11
  370. package/src/models/IntegrationCredential.ts +0 -13
  371. package/src/models/IntialQuestionAnswer.ts +0 -8
  372. package/src/models/JobRun.ts +0 -16
  373. package/src/models/KindEnum.ts +0 -14
  374. package/src/models/LLMCredentialRequest.ts +0 -19
  375. package/src/models/LLMCredentialResponse.ts +0 -13
  376. package/src/models/LLMModelForTenant.ts +0 -11
  377. package/src/models/LLMQuestion.ts +0 -20
  378. package/src/models/LLMResponse.ts +0 -19
  379. package/src/models/LLMTracesListResponse.ts +0 -10
  380. package/src/models/LanguagesView.ts +0 -10
  381. package/src/models/LinkCourseRequest.ts +0 -8
  382. package/src/models/LinkCourseResponse.ts +0 -10
  383. package/src/models/LlmProviderEnum.ts +0 -12
  384. package/src/models/MCPServer.ts +0 -26
  385. package/src/models/MemoryComponentData.ts +0 -10
  386. package/src/models/MemoryComponentMemory.ts +0 -9
  387. package/src/models/MemoryComponentMemoryDetail.ts +0 -13
  388. package/src/models/MemoryComponentResponse.ts +0 -10
  389. package/src/models/MemoryProgress.ts +0 -13
  390. package/src/models/MemoryStatusRequestView.ts +0 -11
  391. package/src/models/MemoryStatusView.ts +0 -11
  392. package/src/models/Mentor.ts +0 -92
  393. package/src/models/MentorAudience.ts +0 -10
  394. package/src/models/MentorCategory.ts +0 -14
  395. package/src/models/MentorCategoryCreate.ts +0 -16
  396. package/src/models/MentorCategoryGroup.ts +0 -16
  397. package/src/models/MentorCategoryGroupCreate.ts +0 -16
  398. package/src/models/MentorCreate.ts +0 -89
  399. package/src/models/MentorCustomVoice.ts +0 -9
  400. package/src/models/MentorCustomVoiceResponse.ts +0 -9
  401. package/src/models/MentorData.ts +0 -12
  402. package/src/models/MentorDetailAnalytics.ts +0 -11
  403. package/src/models/MentorEval.ts +0 -16
  404. package/src/models/MentorEvalQuestion.ts +0 -10
  405. package/src/models/MentorEvalQuestionRequest.ts +0 -9
  406. package/src/models/MentorEvalReport.ts +0 -15
  407. package/src/models/MentorEvalRequest.ts +0 -13
  408. package/src/models/MentorFacet.ts +0 -22
  409. package/src/models/MentorFork.ts +0 -10
  410. package/src/models/MentorFromTemplateRequest.ts +0 -9
  411. package/src/models/MentorFromTemplateWithSettingRequest.ts +0 -52
  412. package/src/models/MentorMemorySettingsRequest.ts +0 -11
  413. package/src/models/MentorMemorySettingsResponse.ts +0 -11
  414. package/src/models/MentorMetadata.ts +0 -10
  415. package/src/models/MentorScenario.ts +0 -11
  416. package/src/models/MentorScenarioPrompt.ts +0 -10
  417. package/src/models/MentorSearchResponse.ts +0 -40
  418. package/src/models/MentorSession.ts +0 -9
  419. package/src/models/MentorSettings.ts +0 -65
  420. package/src/models/MentorSettingsPublic.ts +0 -51
  421. package/src/models/MentorSettingsRequest.ts +0 -67
  422. package/src/models/MentorVisibilityEnum.ts +0 -14
  423. package/src/models/MentorWizard.ts +0 -9
  424. package/src/models/MessageStatistics.ts +0 -10
  425. package/src/models/MessageView.ts +0 -15
  426. package/src/models/MessageViewRequest.ts +0 -12
  427. package/src/models/MessageViewUpdatResponse.ts +0 -8
  428. package/src/models/Metadata.ts +0 -10
  429. package/src/models/MetricChange.ts +0 -9
  430. package/src/models/ModelCost.ts +0 -9
  431. package/src/models/ModerationLog.ts +0 -16
  432. package/src/models/NoChatMessagesFound.ts +0 -8
  433. package/src/models/NullEnum.ts +0 -7
  434. package/src/models/PageContent.ts +0 -11
  435. package/src/models/PaginatedAIGeneratedImageList.ts +0 -12
  436. package/src/models/PaginatedConversationsList.ts +0 -12
  437. package/src/models/PaginatedCourseCreationTaskFileList.ts +0 -12
  438. package/src/models/PaginatedCourseCreationTaskList.ts +0 -12
  439. package/src/models/PaginatedEdxCourseList.ts +0 -12
  440. package/src/models/PaginatedEmailPromptListList.ts +0 -12
  441. package/src/models/PaginatedHeygenMarketingVideoListList.ts +0 -12
  442. package/src/models/PaginatedHeygenTemplateResponseSingleList.ts +0 -12
  443. package/src/models/PaginatedJobRunList.ts +0 -12
  444. package/src/models/PaginatedMCPServerList.ts +0 -12
  445. package/src/models/PaginatedMentorList.ts +0 -12
  446. package/src/models/PaginatedModerationLogList.ts +0 -12
  447. package/src/models/PaginatedPeriodicAgentList.ts +0 -12
  448. package/src/models/PaginatedPeriodicAgentLogList.ts +0 -12
  449. package/src/models/PaginatedPlayWrightScriptList.ts +0 -12
  450. package/src/models/PaginatedSectionList.ts +0 -12
  451. package/src/models/PaginatedSubSectionList.ts +0 -12
  452. package/src/models/PaginatedTopicStatisticsResponse.ts +0 -12
  453. package/src/models/PaginatedUnitList.ts +0 -12
  454. package/src/models/PaginatedUserEdxMemoryList.ts +0 -12
  455. package/src/models/PaginatedVoiceList.ts +0 -12
  456. package/src/models/PatchedCallConfiguration.ts +0 -31
  457. package/src/models/PatchedConversations.ts +0 -33
  458. package/src/models/PatchedCourseCreationTaskFile.ts +0 -12
  459. package/src/models/PatchedCredentialRequest.ts +0 -19
  460. package/src/models/PatchedLLMCredentialRequest.ts +0 -19
  461. package/src/models/PatchedMCPServer.ts +0 -26
  462. package/src/models/PatchedMentorCategoryGroupCreate.ts +0 -16
  463. package/src/models/PatchedMentorCreate.ts +0 -89
  464. package/src/models/PatchedPeriodicAgentCreate.ts +0 -46
  465. package/src/models/PatchedPlayWrightScript.ts +0 -17
  466. package/src/models/PatchedPrompt.ts +0 -27
  467. package/src/models/PatchedSection.ts +0 -14
  468. package/src/models/PatchedSubSection.ts +0 -14
  469. package/src/models/PatchedUnit.ts +0 -16
  470. package/src/models/PeriodicAgent.ts +0 -47
  471. package/src/models/PeriodicAgentCreate.ts +0 -46
  472. package/src/models/PeriodicAgentLog.ts +0 -16
  473. package/src/models/PeriodicAgentLogStatusEnum.ts +0 -14
  474. package/src/models/PeriodicTask.ts +0 -26
  475. package/src/models/PieChartData.ts +0 -10
  476. package/src/models/PieChartSegment.ts +0 -9
  477. package/src/models/PinnedMessageCreate.ts +0 -14
  478. package/src/models/PinnedMessageGet.ts +0 -12
  479. package/src/models/PinnedMessageRequest.ts +0 -11
  480. package/src/models/PlayWrightScript.ts +0 -17
  481. package/src/models/PredictiveAnalyticsRequest.ts +0 -9
  482. package/src/models/PredictiveAnalyticsResponse.ts +0 -9
  483. package/src/models/PreviousAgentStatusEnum.ts +0 -16
  484. package/src/models/Prompt.ts +0 -27
  485. package/src/models/PromptCategory.ts +0 -12
  486. package/src/models/PromptFacet.ts +0 -22
  487. package/src/models/PromptSearchResponse.ts +0 -40
  488. package/src/models/PromptVisibilityEnum.ts +0 -14
  489. package/src/models/ProviderEnum.ts +0 -14
  490. package/src/models/QuestionCardTag.ts +0 -13
  491. package/src/models/QuestionRequest.ts +0 -20
  492. package/src/models/QuestionResponse.ts +0 -15
  493. package/src/models/RatingEnum.ts +0 -12
  494. package/src/models/RatingRecord.ts +0 -9
  495. package/src/models/RecentlyAccessedMentor.ts +0 -13
  496. package/src/models/RecommendCourseBlock.ts +0 -8
  497. package/src/models/RecommendCourseResponse.ts +0 -8
  498. package/src/models/RecommendedCoursesResponse.ts +0 -38
  499. package/src/models/RelatedText.ts +0 -8
  500. package/src/models/RequestDataVariable.ts +0 -19
  501. package/src/models/ResourceScrappedData.ts +0 -18
  502. package/src/models/ResourceScrappedDataStatusEnum.ts +0 -16
  503. package/src/models/ResponseDataVariable.ts +0 -19
  504. package/src/models/RetreiverTrainViewRequest.ts +0 -15
  505. package/src/models/RetreiverTrainViewResponse.ts +0 -11
  506. package/src/models/RetrieveTask.ts +0 -8
  507. package/src/models/RetrieverDocumentEmbedding.ts +0 -22
  508. package/src/models/RetrieverDocumentEmbeddingRequest.ts +0 -35
  509. package/src/models/RetrieverRequestSearch.ts +0 -15
  510. package/src/models/RetrieverRequestSearchDocument.ts +0 -15
  511. package/src/models/RetrieverResponseSearch.ts +0 -12
  512. package/src/models/ReuestDataVariableList.ts +0 -9
  513. package/src/models/RunMentorEval.ts +0 -8
  514. package/src/models/ScanWebhookRequest.ts +0 -11
  515. package/src/models/ScanWebhookResponse.ts +0 -8
  516. package/src/models/Section.ts +0 -14
  517. package/src/models/SectionWithChildren.ts +0 -16
  518. package/src/models/SeedMentorsView.ts +0 -8
  519. package/src/models/SentimentSummary.ts +0 -9
  520. package/src/models/SessionBrowserScreenshot.ts +0 -13
  521. package/src/models/SessionDetail.ts +0 -11
  522. package/src/models/SessionMemoryStorage.ts +0 -11
  523. package/src/models/ShellLogs.ts +0 -8
  524. package/src/models/SpacedRepetitionLearningPath.ts +0 -8
  525. package/src/models/SpacedRepetitionQuestionStats.ts +0 -10
  526. package/src/models/StarMentor.ts +0 -12
  527. package/src/models/Status6eeEnum.ts +0 -16
  528. package/src/models/Step.ts +0 -14
  529. package/src/models/StepStatusEnum.ts +0 -14
  530. package/src/models/SttProviderEnum.ts +0 -16
  531. package/src/models/StudentChatMessage.ts +0 -9
  532. package/src/models/StylesView.ts +0 -9
  533. package/src/models/SubSection.ts +0 -14
  534. package/src/models/SubSectionWithChildren.ts +0 -16
  535. package/src/models/TagsView.ts +0 -10
  536. package/src/models/TargetSystemEnum.ts +0 -12
  537. package/src/models/TaskView.ts +0 -8
  538. package/src/models/TemplateMentor.ts +0 -14
  539. package/src/models/TenantMentorTraces.ts +0 -11
  540. package/src/models/ThemeEnum.ts +0 -12
  541. package/src/models/TonesView.ts +0 -9
  542. package/src/models/ToolResponse.ts +0 -16
  543. package/src/models/TopicModel.ts +0 -8
  544. package/src/models/TopicRecord.ts +0 -9
  545. package/src/models/TopicStatistics.ts +0 -12
  546. package/src/models/TopicStatisticsResponse.ts +0 -11
  547. package/src/models/TopicSummaryView.ts +0 -9
  548. package/src/models/TrainChatSessionDocumentView.ts +0 -11
  549. package/src/models/TrainChatSessionDocumentViewRequest.ts +0 -11
  550. package/src/models/TrainDocumentViewRequest.ts +0 -47
  551. package/src/models/TrainDocumentViewResponse.ts +0 -20
  552. package/src/models/TrainingStatusEnum.ts +0 -16
  553. package/src/models/TransportEnum.ts +0 -12
  554. package/src/models/TrendEntry.ts +0 -9
  555. package/src/models/TriggerRequest.ts +0 -10
  556. package/src/models/TriggerResponse.ts +0 -11
  557. package/src/models/TtsProviderEnum.ts +0 -14
  558. package/src/models/TypeC42Enum.ts +0 -12
  559. package/src/models/Unit.ts +0 -16
  560. package/src/models/UnitWithChildren.ts +0 -18
  561. package/src/models/UseMainCreds.ts +0 -8
  562. package/src/models/UserAllChatMemoryView.ts +0 -12
  563. package/src/models/UserCatalogItemMemoryView.ts +0 -19
  564. package/src/models/UserChatByPeriod.ts +0 -9
  565. package/src/models/UserChatFeedback.ts +0 -19
  566. package/src/models/UserChatFeedbackCount.ts +0 -9
  567. package/src/models/UserChatMemoryStatusRequestView.ts +0 -11
  568. package/src/models/UserChatMemoryStatusView.ts +0 -11
  569. package/src/models/UserChatMemoryUpdateView.ts +0 -15
  570. package/src/models/UserCountRecord.ts +0 -9
  571. package/src/models/UserEdxMemory.ts +0 -20
  572. package/src/models/UserMemoryContextRequest.ts +0 -18
  573. package/src/models/UserMemoryContextResponse.ts +0 -17
  574. package/src/models/UserMetric.ts +0 -9
  575. package/src/models/UserMetricsResponse.ts +0 -12
  576. package/src/models/UserSentimentCountView.ts +0 -9
  577. package/src/models/UserTrendByPeriod.ts +0 -10
  578. package/src/models/VectorResult.ts +0 -13
  579. package/src/models/VideoCaption.ts +0 -8
  580. package/src/models/Voice.ts +0 -14
  581. package/src/models/WebResource.ts +0 -14
  582. package/src/models/WebResourceCard.ts +0 -12
  583. package/src/models/WebResourcesQuery.ts +0 -8
  584. package/src/services/AiAccountService.ts +0 -505
  585. package/src/services/AiAnalyticsService.ts +0 -6439
  586. package/src/services/AiIndexService.ts +0 -718
  587. package/src/services/AiMarketingService.ts +0 -96
  588. package/src/services/AiMediaService.ts +0 -289
  589. package/src/services/AiMentorService.ts +0 -9103
  590. package/src/services/AiPromptService.ts +0 -1980
@@ -1,3899 +0,0 @@
1
- import type { ActiveUsersList } from '../models/ActiveUsersList';
2
- import type { ActiveUsersPerCourse } from '../models/ActiveUsersPerCourse';
3
- import type { ActivityAPI } from '../models/ActivityAPI';
4
- import type { AnalyticsOverview } from '../models/AnalyticsOverview';
5
- import type { Average } from '../models/Average';
6
- import type { AverageOvertime } from '../models/AverageOvertime';
7
- import type { AvgCourseGradeWithCutoff } from '../models/AvgCourseGradeWithCutoff';
8
- import type { ChatHistoryFilterData } from '../models/ChatHistoryFilterData';
9
- import type { ConversationMessage } from '../models/ConversationMessage';
10
- import type { Conversations } from '../models/Conversations';
11
- import type { ConversationSummary } from '../models/ConversationSummary';
12
- import type { ConversationVolume } from '../models/ConversationVolume';
13
- import type { Cost } from '../models/Cost';
14
- import type { CostPerTenant } from '../models/CostPerTenant';
15
- import type { CourseCompletionPerCourse } from '../models/CourseCompletionPerCourse';
16
- import type { CourseCompletionSummaryOvertime } from '../models/CourseCompletionSummaryOvertime';
17
- import type { CourseGradeSummary } from '../models/CourseGradeSummary';
18
- import type { CourseGradingDetail } from '../models/CourseGradingDetail';
19
- import type { DetailedGradeView } from '../models/DetailedGradeView';
20
- import type { EngagementPerCourse } from '../models/EngagementPerCourse';
21
- import type { Enrollments } from '../models/Enrollments';
22
- import type { EnrollmentsPerUser } from '../models/EnrollmentsPerUser';
23
- import type { GradingPerUser } from '../models/GradingPerUser';
24
- import type { GroupList } from '../models/GroupList';
25
- import type { LearnerInformationAPI } from '../models/LearnerInformationAPI';
26
- import type { LLMTracesListResponse } from '../models/LLMTracesListResponse';
27
- import type { MentorDetailAnalytics } from '../models/MentorDetailAnalytics';
28
- import type { MessageStatistics } from '../models/MessageStatistics';
29
- import type { ModelCost } from '../models/ModelCost';
30
- import type { NewPerLearnerList } from '../models/NewPerLearnerList';
31
- import type { OvertimeWithChangeInfo } from '../models/OvertimeWithChangeInfo';
32
- import type { OverTimeWithTotal } from '../models/OverTimeWithTotal';
33
- import type { PaginatedConversationsList } from '../models/PaginatedConversationsList';
34
- import type { PaginatedTopicStatisticsResponse } from '../models/PaginatedTopicStatisticsResponse';
35
- import type { PatchedConversations } from '../models/PatchedConversations';
36
- import type { PerformanceGradesPerCourse } from '../models/PerformanceGradesPerCourse';
37
- import type { PerLearnerCourseVideosWatched } from '../models/PerLearnerCourseVideosWatched';
38
- import type { PerlearnerEngagementVideosWatchedPerCourse } from '../models/PerlearnerEngagementVideosWatchedPerCourse';
39
- import type { PerlearnerGradeSummary } from '../models/PerlearnerGradeSummary';
40
- import type { PerlearnerGradeWithCutOff } from '../models/PerlearnerGradeWithCutOff';
41
- import type { PerlearnerGradingPerCourseAPI } from '../models/PerlearnerGradingPerCourseAPI';
42
- import type { PerLearnerLastAccess } from '../models/PerLearnerLastAccess';
43
- import type { PerLearnerTimeSpentInCourseTree } from '../models/PerLearnerTimeSpentInCourseTree';
44
- import type { PerlearnerUserList } from '../models/PerlearnerUserList';
45
- import type { PieChartData } from '../models/PieChartData';
46
- import type { RatingRecord } from '../models/RatingRecord';
47
- import type { SentimentSummary } from '../models/SentimentSummary';
48
- import type { StudentChatMessage } from '../models/StudentChatMessage';
49
- import type { TenantMentorTraces } from '../models/TenantMentorTraces';
50
- import type { TimeDetail } from '../models/TimeDetail';
51
- import type { TimeSpentByUsersInCourse } from '../models/TimeSpentByUsersInCourse';
52
- import type { TimeSpentPerCourse } from '../models/TimeSpentPerCourse';
53
- import type { TopicRecord } from '../models/TopicRecord';
54
- import type { TopicStatisticsResponse } from '../models/TopicStatisticsResponse';
55
- import type { TopicSummaryView } from '../models/TopicSummaryView';
56
- import type { TrendEntry } from '../models/TrendEntry';
57
- import type { UserChatByPeriod } from '../models/UserChatByPeriod';
58
- import type { UserChatFeedbackCount } from '../models/UserChatFeedbackCount';
59
- import type { UserCountRecord } from '../models/UserCountRecord';
60
- import type { UserMetricsResponse } from '../models/UserMetricsResponse';
61
- import type { UserSentimentCountView } from '../models/UserSentimentCountView';
62
- import type { UserTrendByPeriod } from '../models/UserTrendByPeriod';
63
- import type { Value } from '../models/Value';
64
- import type { VideoEngagementPerCourse } from '../models/VideoEngagementPerCourse';
65
- import type { VideosInCourseSummary } from '../models/VideosInCourseSummary';
66
- import type { VideosSpecificCourse } from '../models/VideosSpecificCourse';
67
- import type { WatchedVideosPerUser } from '../models/WatchedVideosPerUser';
68
- import type { CancelablePromise } from '../core/CancelablePromise';
69
- export declare class AiAnalyticsService {
70
- /**
71
- * Get active user counts over time.
72
- *
73
- * This endpoint provides daily counts of active users (users with known activity)
74
- * over a specified time period.
75
- *
76
- * Query Parameters:
77
- * start_date (str, optional): Start date for the time range (ISO format)
78
- * end_date (str, optional): End date for the time range (ISO format)
79
- *
80
- * Returns:
81
- * Daily active user counts over the specified time period, with change metrics
82
- * compared to previous periods.
83
- *
84
- * Default time range is the last 7 days if no dates are specified.
85
- *
86
- * An active user is defined as a user with any activity within the past 30 days.
87
- * @returns OvertimeWithChangeInfo
88
- * @throws ApiError
89
- */
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>;
115
- /**
116
- * Get active user counts on a per-course basis.
117
- *
118
- * This endpoint provides counts of active users for each course within
119
- * the specified date range.
120
- *
121
- * Query Parameters:
122
- * start_date (str, optional): Start date for filtering (ISO format)
123
- * end_date (str, optional): End date for filtering (ISO format)
124
- *
125
- * Returns:
126
- * A list of courses with their active user counts.
127
- *
128
- * Default time range is the last 7 days if no dates are specified.
129
- * @returns ActiveUsersPerCourse
130
- * @throws ApiError
131
- */
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>;
157
- /**
158
- * Get a list of active users with activity metrics.
159
- *
160
- * This endpoint provides a paginated list of users who have had activity
161
- * within the specified date range.
162
- *
163
- * Query Parameters:
164
- * start_date (str, optional): Start date for filtering (ISO format)
165
- * end_date (str, optional): End date for filtering (ISO format)
166
- * course_id (str, optional): Filter by course ID
167
- * page (int, optional): Page number for pagination
168
- * length (int, optional): Number of items per page
169
- *
170
- * Returns:
171
- * A paginated list of active users with their activity metrics.
172
- *
173
- * Default time range is the last 7 days if no dates are specified.
174
- * @returns ActiveUsersList
175
- * @throws ApiError
176
- */
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>;
202
- /**
203
- * Get enrollment or unenrollment counts over time.
204
- *
205
- * This endpoint provides daily counts of new enrollments or unenrollments
206
- * over a specified time period.
207
- *
208
- * Query Parameters:
209
- * start_date (str, optional): Start date for the time range (ISO format)
210
- * end_date (str, optional): End date for the time range (ISO format)
211
- * course_id (str, optional): Filter by course ID
212
- * active (bool): Get enrollments when true, unenrollments when false
213
- *
214
- * Returns:
215
- * Daily counts over the specified time period, with change metrics
216
- * compared to previous periods.
217
- *
218
- * Default time range is the last 7 days if no dates are specified.
219
- * @returns OvertimeWithChangeInfo
220
- * @throws ApiError
221
- */
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>;
261
- /**
262
- * List users enrolled in a specific course.
263
- *
264
- * This endpoint provides a list of users who are enrolled or unenrolled
265
- * in a specified course.
266
- *
267
- * Query Parameters:
268
- * course_id (str): The course ID to get enrollments for
269
- * active (bool): Filter for active enrollments when true, inactive when false
270
- * page (int, optional): Page number for pagination
271
- * length (int, optional): Number of items per page
272
- *
273
- * Returns:
274
- * A paginated list of users with:
275
- * - Username
276
- * - Full name
277
- * - Email
278
- * - Enrollment timestamp
279
- * @returns EnrollmentsPerUser
280
- * @throws ApiError
281
- */
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>;
329
- /**
330
- * Get enrollment or unenrollment counts over time.
331
- *
332
- * This endpoint provides daily counts of new enrollments or unenrollments
333
- * over a specified time period.
334
- *
335
- * Query Parameters:
336
- * start_date (str, optional): Start date for the time range (ISO format)
337
- * end_date (str, optional): End date for the time range (ISO format)
338
- * course_id (str, optional): Filter by course ID
339
- * active (bool): Get enrollments when true, unenrollments when false
340
- *
341
- * Returns:
342
- * Daily counts over the specified time period, with change metrics
343
- * compared to previous periods.
344
- *
345
- * Default time range is the last 7 days if no dates are specified.
346
- * @returns OvertimeWithChangeInfo
347
- * @throws ApiError
348
- */
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>;
387
- /**
388
- * List enrollment statistics on a per-course basis.
389
- *
390
- * This endpoint provides enrollment counts for all courses, with options
391
- * to filter for active or inactive enrollments and to include time-based data.
392
- *
393
- * Query Parameters:
394
- * active (bool): Filter for active enrollments when true, inactive when false
395
- * start_date (str, optional): Start date for time-based filtering (ISO format)
396
- * end_date (str, optional): End date for time-based filtering (ISO format)
397
- * page (int, optional): Page number for pagination
398
- * length (int, optional): Number of items per page
399
- *
400
- * Returns:
401
- * A paginated list of courses with their enrollment counts and percentages.
402
- * @returns Enrollments
403
- * @throws ApiError
404
- */
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>;
451
- /**
452
- * List all learners on the platform with aggregated metrics.
453
- *
454
- * This endpoint returns a paginated list of all learners with key metrics including:
455
- * - Enrollment counts
456
- * - Completion counts
457
- * - Time spent on platform
458
- *
459
- * Query Parameters:
460
- * page (int): Page number for pagination
461
- * length (int): Number of items per page
462
- * search (str): Filter learners by username, email, or name
463
- *
464
- * Returns:
465
- * A paginated list of learners with their associated metrics.
466
- * @returns PerlearnerUserList
467
- * @throws ApiError
468
- */
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>;
498
- /**
499
- * Get registered user counts over time.
500
- *
501
- * This endpoint provides daily counts of new user registrations over a
502
- * specified time period.
503
- *
504
- * Query Parameters:
505
- * start_date (str, optional): Start date for the time range (ISO format)
506
- * end_date (str, optional): End date for the time range (ISO format)
507
- *
508
- * Returns:
509
- * Daily registration counts over the specified time period, with change metrics
510
- * compared to previous periods.
511
- *
512
- * Default time range is the last 7 days if no dates are specified.
513
- * @returns OvertimeWithChangeInfo
514
- * @throws ApiError
515
- */
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>;
541
- /**
542
- * List enrollment statistics on a per-course basis.
543
- *
544
- * This endpoint provides enrollment counts for all courses, with options
545
- * to filter for active or inactive enrollments and to include time-based data.
546
- *
547
- * Query Parameters:
548
- * active (bool): Filter for active enrollments when true, inactive when false
549
- * start_date (str, optional): Start date for time-based filtering (ISO format)
550
- * end_date (str, optional): End date for time-based filtering (ISO format)
551
- * page (int, optional): Page number for pagination
552
- * length (int, optional): Number of items per page
553
- *
554
- * Returns:
555
- * A paginated list of courses with their enrollment counts and percentages.
556
- * @returns Enrollments
557
- * @throws ApiError
558
- */
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>;
605
- /**
606
- * Retrieve paginated LLM usage costs aggregated by tenant.
607
- * @returns CostPerTenant
608
- * @throws ApiError
609
- */
610
- static aiAnalyticsCostsPertenantList({ endDate, startDate, }: {
611
- endDate: string;
612
- startDate: string;
613
- }): CancelablePromise<Array<CostPerTenant>>;
614
- /**
615
- * Get a list of departments with metrics and filtering options.
616
- *
617
- * This endpoint provides a paginated list of departments with aggregated metrics
618
- * about learner performance, course completions, and skill acquisition.
619
- *
620
- * Query Parameters:
621
- * page (int, optional): Page number for pagination
622
- * length (int, optional): Number of items per page
623
- * program (str, optional): Filter by program
624
- * pathway (str, optional): Filter by pathway
625
- * departments (list, optional): Filter by department ids
626
- * department_id (str, optional): Filter by department id
627
- * location (str, optional): Filter by location
628
- * is_enrolled (bool, optional): Filter for departments with enrolled users
629
- * start_date (date, optional): Filter by learner join date (start range)
630
- * end_date (date, optional): Filter by learner join date (end range)
631
- *
632
- * Returns:
633
- * A paginated list of departments with comprehensive metrics.
634
- * @returns GroupList
635
- * @throws ApiError
636
- */
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>;
690
- /**
691
- * Get engagement metrics on a per-course basis.
692
- *
693
- * This endpoint provides a paginated list of courses with engagement metrics
694
- * including activity counts, time spent, and interaction data.
695
- *
696
- * Query Parameters:
697
- * page (int, optional): Page number for pagination
698
- * length (int, optional): Number of items per page
699
- *
700
- * Returns:
701
- * A paginated list of courses with their engagement metrics.
702
- * @returns EngagementPerCourse
703
- * @throws ApiError
704
- */
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>;
730
- /**
731
- * Completion count per user per course across the platform
732
- *
733
- * Query Params
734
- * 1. start_date e.g 2020-10-01
735
- * 2. end_date e.g 2020-10-10
736
- *
737
- * Default result when no query param is added is last_7_days (today inclusive)
738
- * @returns OvertimeWithChangeInfo
739
- * @throws ApiError
740
- */
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>;
766
- /**
767
- * List course completion metrics on a per-course basis.
768
- *
769
- * This endpoint provides a paginated table of courses with enrollment and
770
- * completion statistics for each course.
771
- *
772
- * Returns:
773
- * A paginated list of courses with:
774
- * - Course identification (ID and name)
775
- * - Enrollment count
776
- * - Completion count
777
- * - Average completion rate
778
- * @returns CourseCompletionPerCourse
779
- * @throws ApiError
780
- */
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>;
806
- /**
807
- * Average time spent in secs on a per-day basis
808
- *
809
- * Query Params
810
- * 1. start_date e.g 2020-10-01
811
- * 2. end_date e.g 2020-10-10
812
- * 3. course_id <optional>
813
- *
814
- * Default result when no query param is added is last_7_days (today inclusive)
815
- * @returns AverageOvertime
816
- * @throws ApiError
817
- */
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>;
844
- /**
845
- * Time spent per course in secs in a tree like form
846
- *
847
- * Kwargs
848
- * course_id e.g course-v1:Org+Course4+Run
849
- *
850
- * Query Params
851
- * 1. start_date <optional> e.g 2020-10-01
852
- * 2. end_date <optional> e.g 2020-10-10
853
- * @returns TimeDetail
854
- * @throws ApiError
855
- */
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>;
874
- /**
875
- * Time spent per course in secs on a per-day basis
876
- *
877
- * Query Params
878
- * 1. start_date e.g 2020-10-01
879
- * 2. end_date e.g 2020-10-10
880
- * Kwargs
881
- * 3. course_id
882
- *
883
- * Default result when no query param is added is last_7_days (today inclusive)
884
- * @returns OverTimeWithTotal
885
- * @throws ApiError
886
- */
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>;
913
- /**
914
- * Time spent by users in a course
915
- *
916
- * Query Params
917
- * course_id e.g course-v1:Org+Course4+Run
918
- * @returns TimeSpentByUsersInCourse
919
- * @throws ApiError
920
- */
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>;
955
- /**
956
- * Time spent within a course in ordered hierarchical format
957
- *
958
- * Kwargs
959
- * 1. course_id e.g course-v1:Org+Course4+Run
960
- * 2. user_id e.g developer@ibleducation.com or dev123 (username|email)
961
- * Query Params
962
- * 3. start_date <optional> e.g 2020-10-01
963
- * 4. end_date <optional> e.g 2020-10-10
964
- * @returns PerLearnerTimeSpentInCourseTree
965
- * @throws ApiError
966
- */
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>;
988
- /**
989
- * Time spent in secs on a per-day basis
990
- *
991
- * Query Params
992
- * 1. course_id <optional> e.g course-v1:Org+Course4+Run
993
- * 2. user_id <optional> e.g developer@ibleducation.com or dev123 (username|email)
994
- * 3. start_date e.g 2020-10-01
995
- * 4. end_date e.g 2020-10-10
996
- *
997
- * Default result when no query param is added is last_7_days (today inclusive)
998
- * @returns OverTimeWithTotal
999
- * @throws ApiError
1000
- */
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>;
1022
- /**
1023
- * Get video engagement metrics for a specific course.
1024
- *
1025
- * This endpoint provides detailed video engagement statistics for a single course,
1026
- * including view counts, completion rates, and time spent on videos.
1027
- *
1028
- * Query Parameters:
1029
- * course_id (str): The course ID to get video engagement data for
1030
- *
1031
- * Returns:
1032
- * Detailed video engagement metrics for the specified course.
1033
- * @returns VideosSpecificCourse
1034
- * @throws ApiError
1035
- */
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>;
1054
- /**
1055
- * Get video watch counts over time.
1056
- *
1057
- * This endpoint provides daily counts of videos watched over a specified time period,
1058
- * with options to filter by course or user.
1059
- *
1060
- * Query Parameters:
1061
- * start_date (str, optional): Start date for the time range (ISO format)
1062
- * end_date (str, optional): End date for the time range (ISO format)
1063
- * course_id (str, optional): Filter by course ID
1064
- * user_id (str, optional): Filter by username or email
1065
- *
1066
- * Returns:
1067
- * Daily video watch counts over the specified time period.
1068
- *
1069
- * Default time range is the last 7 days if no dates are specified.
1070
- *
1071
- * Access Control:
1072
- * - Platform admins can access any video watch data
1073
- * - Learners can access their own video watch data
1074
- * @returns OverTimeWithTotal
1075
- * @throws ApiError
1076
- */
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>;
1103
- /**
1104
- * Get a summary of video watch statistics for a specific course.
1105
- *
1106
- * This endpoint provides a structured summary of video watch data for a course,
1107
- * organized in a tree-like format by course sections and subsections.
1108
- *
1109
- * Query Parameters:
1110
- * course_id (str): The course ID to get video summary for
1111
- *
1112
- * Returns:
1113
- * A hierarchical structure of video watch data for the course, including:
1114
- * - Section and subsection organization
1115
- * - Video identification and metadata
1116
- * - Watch counts and completion rates
1117
- * @returns VideosInCourseSummary
1118
- * @throws ApiError
1119
- */
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>;
1138
- /**
1139
- * List of users' videos completed records for a specific course
1140
- *
1141
- * Kwargs
1142
- * course_id e.g course-v1:Org+Course4+Run
1143
- * @returns WatchedVideosPerUser
1144
- * @throws ApiError
1145
- */
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>;
1164
- /**
1165
- * Average time spent by a learner in enrolled courses. Gives a rough estimate of whats the average time
1166
- * that would be spent by a learner in a course
1167
- *
1168
- * Query Params
1169
- * 1. start_date e.g 2020-10-01
1170
- * 2. end_date e.g 2020-10-10
1171
- * @returns AverageOvertime
1172
- * @throws ApiError
1173
- */
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>;
1199
- /**
1200
- * Average time spent in secs on a per-day basis
1201
- *
1202
- * Query Params
1203
- * 1. start_date e.g 2020-10-01
1204
- * 2. end_date e.g 2020-10-10
1205
- * 3. course_id <optional>
1206
- *
1207
- * Default result when no query param is added is last_7_days (today inclusive)
1208
- * @returns AverageOvertime
1209
- * @throws ApiError
1210
- */
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>;
1236
- /**
1237
- * Get time spent on the platform over time.
1238
- *
1239
- * This endpoint provides daily time spent values (in seconds) across the
1240
- * platform over a specified time period.
1241
- *
1242
- * Query Parameters:
1243
- * start_date (str, optional): Start date for the time range (ISO format)
1244
- * end_date (str, optional): End date for the time range (ISO format)
1245
- *
1246
- * Returns:
1247
- * Daily time spent values over the specified time period, with change metrics
1248
- * compared to previous periods.
1249
- *
1250
- * Default time range is the last 7 days if no dates are specified.
1251
- * @returns OvertimeWithChangeInfo
1252
- * @throws ApiError
1253
- */
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>;
1279
- /**
1280
- * Get time spent statistics on a per-course basis.
1281
- *
1282
- * This endpoint provides a paginated list of courses with the total time
1283
- * spent by users in each course.
1284
- *
1285
- * Query Parameters:
1286
- * start_date (str, optional): Start date for filtering (ISO format)
1287
- * end_date (str, optional): End date for filtering (ISO format)
1288
- * page (int, optional): Page number for pagination
1289
- * length (int, optional): Number of items per page
1290
- *
1291
- * Returns:
1292
- * A paginated list of courses with:
1293
- * - Course identification (ID and name)
1294
- * - Total time spent (in seconds)
1295
- * - Formatted time spent (human-readable)
1296
- * - Percentage of total platform time
1297
- * @returns TimeSpentPerCourse
1298
- * @throws ApiError
1299
- */
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>;
1333
- /**
1334
- * Get video engagement metrics on a per-course basis.
1335
- *
1336
- * This endpoint provides a paginated list of courses with video engagement metrics
1337
- * including view counts, completion rates, and time spent on videos.
1338
- *
1339
- * Query Parameters:
1340
- * page (int, optional): Page number for pagination
1341
- * length (int, optional): Number of items per page
1342
- *
1343
- * Returns:
1344
- * A paginated list of courses with their video engagement metrics.
1345
- * @returns VideoEngagementPerCourse
1346
- * @throws ApiError
1347
- */
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>;
1373
- /**
1374
- * Get video watch counts over time.
1375
- *
1376
- * This endpoint provides daily counts of videos watched over a specified time period,
1377
- * with options to filter by course or user.
1378
- *
1379
- * Query Parameters:
1380
- * start_date (str, optional): Start date for the time range (ISO format)
1381
- * end_date (str, optional): End date for the time range (ISO format)
1382
- * course_id (str, optional): Filter by course ID
1383
- * user_id (str, optional): Filter by username or email
1384
- *
1385
- * Returns:
1386
- * Daily video watch counts over the specified time period.
1387
- *
1388
- * Default time range is the last 7 days if no dates are specified.
1389
- *
1390
- * Access Control:
1391
- * - Platform admins can access any video watch data
1392
- * - Learners can access their own video watch data
1393
- * @returns OverTimeWithTotal
1394
- * @throws ApiError
1395
- */
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>;
1421
- /**
1422
- * Retrieve average message counts per session over time.
1423
- *
1424
- * This endpoint returns data on the average number of messages exchanged in each
1425
- * conversation session within a specified date range, with options for filtering
1426
- * by mentor and aggregating by different time periods (hourly, daily, weekly).
1427
- *
1428
- * Args:
1429
- * request: The HTTP request containing filter query parameters.
1430
- * org: Organization key identifier.
1431
- *
1432
- * Returns:
1433
- * Response: Time series of average message counts and session totals.
1434
- *
1435
- * Raises:
1436
- * NotFound: If the specified organization does not exist.
1437
- * BadRequest: If the provided parameters are invalid.
1438
- *
1439
- * Query Parameters:
1440
- * start_date (str): Start date for filtering (YYYY-MM-DD) - required.
1441
- * end_date (str): End date for filtering (YYYY-MM-DD) - required.
1442
- * mentor_id (str): Filter by mentor unique ID.
1443
- * aggregation (str): Time aggregation level (hourly, daily, weekly) - default: daily.
1444
- * @returns MessageStatistics
1445
- * @throws ApiError
1446
- */
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>>;
1468
- /**
1469
- * API viewset for retrieving and filtering chat message history.
1470
- *
1471
- * This viewset provides endpoints for retrieving chat message history
1472
- * within an organization, with extensive filtering options by date range,
1473
- * user, topic, mentor, and sentiment.
1474
- *
1475
- * Permissions:
1476
- * - Restricted to platform administrators only
1477
- * @returns PaginatedConversationsList
1478
- * @throws ApiError
1479
- */
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>;
1495
- /**
1496
- * API viewset for retrieving and filtering chat message history.
1497
- *
1498
- * This viewset provides endpoints for retrieving chat message history
1499
- * within an organization, with extensive filtering options by date range,
1500
- * user, topic, mentor, and sentiment.
1501
- *
1502
- * Permissions:
1503
- * - Restricted to platform administrators only
1504
- * @returns Conversations
1505
- * @throws ApiError
1506
- */
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>;
1517
- /**
1518
- * Retrieve filter options for chat message history.
1519
- *
1520
- * This endpoint returns data on available filter options for the chat message
1521
- * history endpoint, including topics, date ranges (weekly or monthly),
1522
- * sentiments, and users who have chat history.
1523
- *
1524
- * Args:
1525
- * request: The HTTP request containing query parameters.
1526
- * org: Organization key identifier.
1527
- *
1528
- * Returns:
1529
- * Response: Available filter options for chat message history.
1530
- *
1531
- * Raises:
1532
- * NotFound: If the specified organization does not exist.
1533
- *
1534
- * Query Parameters:
1535
- * monthly_range (bool): Whether to return monthly or weekly date ranges.
1536
- * mentor_id (str): Filter users by those who have chatted with a specific mentor.
1537
- * @returns ChatHistoryFilterData
1538
- * @throws ApiError
1539
- */
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>;
1547
- /**
1548
- * API viewset for retrieving and filtering chat message history.
1549
- *
1550
- * This viewset provides endpoints for retrieving chat message history
1551
- * within an organization, with extensive filtering options by date range,
1552
- * user, topic, mentor, and sentiment.
1553
- *
1554
- * Permissions:
1555
- * - Restricted to platform administrators only
1556
- * @returns Conversations
1557
- * @throws ApiError
1558
- */
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>;
1572
- /**
1573
- * API viewset for retrieving and filtering chat message history.
1574
- *
1575
- * This viewset provides endpoints for retrieving chat message history
1576
- * within an organization, with extensive filtering options by date range,
1577
- * user, topic, mentor, and sentiment.
1578
- *
1579
- * Permissions:
1580
- * - Restricted to platform administrators only
1581
- * @returns Conversations
1582
- * @throws ApiError
1583
- */
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>;
1598
- /**
1599
- * API viewset for retrieving and filtering chat message history.
1600
- *
1601
- * This viewset provides endpoints for retrieving chat message history
1602
- * within an organization, with extensive filtering options by date range,
1603
- * user, topic, mentor, and sentiment.
1604
- *
1605
- * Permissions:
1606
- * - Restricted to platform administrators only
1607
- * @returns Conversations
1608
- * @throws ApiError
1609
- */
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>;
1624
- /**
1625
- * API viewset for retrieving and filtering chat message history.
1626
- *
1627
- * This viewset provides endpoints for retrieving chat message history
1628
- * within an organization, with extensive filtering options by date range,
1629
- * user, topic, mentor, and sentiment.
1630
- *
1631
- * Permissions:
1632
- * - Restricted to platform administrators only
1633
- * @returns void
1634
- * @throws ApiError
1635
- */
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>;
1649
- /**
1650
- * Retrieve conversation volume data over time.
1651
- *
1652
- * This endpoint returns data on the number of conversations that occurred
1653
- * within a specified date range, with options for different time aggregations
1654
- * (hourly, daily, weekly). Results can be filtered by mentor.
1655
- *
1656
- * Args:
1657
- * request: The HTTP request containing filter query parameters.
1658
- * org: Organization key identifier.
1659
- * user_id: User identifier (not used in the implementation).
1660
- *
1661
- * Returns:
1662
- * Response: Time series data of conversation counts.
1663
- *
1664
- * Raises:
1665
- * NotFound: If the specified organization does not exist.
1666
- * BadRequest: If the provided parameters are invalid.
1667
- *
1668
- * Query Parameters:
1669
- * start_date (str): Start date for filtering (YYYY-MM-DD) - required.
1670
- * end_date (str): End date for filtering (YYYY-MM-DD) - required.
1671
- * mentor_id (str): Filter by mentor unique ID.
1672
- * aggregation (str): Time aggregation level (hourly, daily, weekly) - default: daily.
1673
- * @returns ConversationVolume
1674
- * @throws ApiError
1675
- */
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>>;
1696
- /**
1697
- * Retrieve a summary of conversation metrics.
1698
- *
1699
- * This endpoint returns aggregated metrics about conversations within an organization,
1700
- * including:
1701
- * - Total number of conversations
1702
- * - Total number of human messages
1703
- * - Total number of AI messages
1704
- *
1705
- * Results can be filtered by mentor.
1706
- *
1707
- * Args:
1708
- * request: The HTTP request containing filter query parameters.
1709
- * org: Organization key identifier.
1710
- *
1711
- * Returns:
1712
- * Response: Summary of conversation metrics.
1713
- *
1714
- * Raises:
1715
- * NotFound: If the specified organization does not exist.
1716
- *
1717
- * Query Parameters:
1718
- * mentor_id (str): Filter by mentor unique ID.
1719
- * @returns ConversationSummary
1720
- * @throws ApiError
1721
- */
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>;
1729
- /**
1730
- * Retrieve the model costs for a tenant
1731
- *
1732
- * Filter parameters for period are start_date and enddate
1733
- *
1734
- * Accessible to tenant Admins only.
1735
- * @returns ModelCost
1736
- * @throws ApiError
1737
- */
1738
- static aiAnalyticsOrgsUsersCostsModelRetrieve({ endDate, org, startDate, userId, }: {
1739
- endDate: string;
1740
- org: string;
1741
- startDate: string;
1742
- }): CancelablePromise<ModelCost>;
1743
- /**
1744
- * Retrieve LLM usage costs aggregated by mentor.
1745
- *
1746
- * This endpoint returns data on the total cost of LLM usage for each mentor
1747
- * within a specified date range, with pagination support. The costs are
1748
- * calculated by summing the costs of all observations associated with
1749
- * traces from the mentor's sessions.
1750
- *
1751
- * Args:
1752
- * request: The HTTP request containing filter query parameters.
1753
- * org: Organization key identifier.
1754
- *
1755
- * Returns:
1756
- * Response: Paginated list of mentors with their total LLM usage costs.
1757
- *
1758
- * Raises:
1759
- * NotFound: If the specified organization does not exist.
1760
- * BadRequest: If the provided parameters are invalid.
1761
- *
1762
- * Query Parameters:
1763
- * start_date (str): Start date for filtering (YYYY-MM-DD) - required.
1764
- * end_date (str): End date for filtering (YYYY-MM-DD) - required.
1765
- * limit (int): Number of results per page - default: 5.
1766
- * offset (int): Offset for pagination - default: 0.
1767
- * @returns TenantMentorTraces
1768
- * @throws ApiError
1769
- */
1770
- static aiAnalyticsOrgsUsersCostsPermentorRetrieve({ endDate, org, startDate, userId, }: {
1771
- endDate: string;
1772
- org: string;
1773
- startDate: string;
1774
- }): CancelablePromise<TenantMentorTraces>;
1775
- /**
1776
- * Retrieve LLM usage costs aggregated by user.
1777
- *
1778
- * This endpoint returns data on the total cost of LLM usage for each user
1779
- * within a specified date range, with pagination support. The costs are
1780
- * calculated by summing the costs of all observations associated with
1781
- * traces from the user's sessions.
1782
- *
1783
- * Args:
1784
- * request: The HTTP request containing filter query parameters.
1785
- * org: Organization key identifier.
1786
- *
1787
- * Returns:
1788
- * Response: Paginated list of users with their total LLM usage costs.
1789
- *
1790
- * Raises:
1791
- * NotFound: If the specified organization does not exist.
1792
- * BadRequest: If the provided parameters are invalid.
1793
- *
1794
- * Query Parameters:
1795
- * start_date (str): Start date for filtering (YYYY-MM-DD) - required.
1796
- * end_date (str): End date for filtering (YYYY-MM-DD) - required.
1797
- * limit (int): Number of results per page - default: 10.
1798
- * offset (int): Offset for pagination - default: 0.
1799
- * @returns LLMTracesListResponse
1800
- * @throws ApiError
1801
- */
1802
- static aiAnalyticsOrgsUsersCostsPeruserRetrieve({ endDate, org, startDate, userId, }: {
1803
- endDate: string;
1804
- org: string;
1805
- startDate: string;
1806
- }): CancelablePromise<LLMTracesListResponse>;
1807
- /**
1808
- * Retrieve summary statistics about mentors.
1809
- *
1810
- * This endpoint returns aggregated statistics about mentors within an organization,
1811
- * including total mentors, active mentors (mentors with at least one session),
1812
- * questions answered, and ratings.
1813
- *
1814
- * Args:
1815
- * request: The HTTP request.
1816
- * org: Organization key identifier.
1817
- *
1818
- * Returns:
1819
- * Response: Summary statistics about mentors.
1820
- *
1821
- * Raises:
1822
- * NotFound: If the specified organization does not exist.
1823
- * @returns MentorDetailAnalytics
1824
- * @throws ApiError
1825
- */
1826
- static aiAnalyticsOrgsUsersMentorDetailRetrieve({ org, userId, }: {
1827
- org: string;
1828
- }): CancelablePromise<MentorDetailAnalytics>;
1829
- /**
1830
- * Retrieve summary statistics about mentors.
1831
- *
1832
- * This endpoint returns aggregated statistics about mentors within an organization,
1833
- * including total mentors, active mentors (mentors with at least one session),
1834
- * questions answered, and ratings.
1835
- *
1836
- * Args:
1837
- * request: The HTTP request.
1838
- * org: Organization key identifier.
1839
- *
1840
- * Returns:
1841
- * Response: Summary statistics about mentors.
1842
- *
1843
- * Raises:
1844
- * NotFound: If the specified organization does not exist.
1845
- * @returns MentorDetailAnalytics
1846
- * @throws ApiError
1847
- */
1848
- static aiAnalyticsOrgsUsersMentorSummaryRetrieve({ org, userId, }: {
1849
- org: string;
1850
- }): CancelablePromise<MentorDetailAnalytics>;
1851
- /**
1852
- * Retrieve LLM usage costs for a specific mentor.
1853
- *
1854
- * This endpoint returns data on the total cost of LLM usage for a specific mentor
1855
- * within a specified date range. The cost is calculated by summing the costs
1856
- * of all observations associated with traces from the tenant's sessions.
1857
- *
1858
- * Args:
1859
- * request: The HTTP request containing filter query parameters.
1860
- * org: Organization key identifier.
1861
- * mentor_unique_id: User key identifier.
1862
- *
1863
- * Returns:
1864
- * Response: Total LLM usage cost for the specified tenant.
1865
- *
1866
- * Raises:
1867
- * NotFound: If the specified organization does not exist.
1868
- * BadRequest: If the provided parameters are invalid.
1869
- *
1870
- * Query Parameters:
1871
- * start_date (str): Start date for filtering (YYYY-MM-DD) - required.
1872
- * end_date (str): End date for filtering (YYYY-MM-DD) - required.
1873
- * @returns Cost
1874
- * @throws ApiError
1875
- */
1876
- static aiAnalyticsOrgsUsersMentorsCostRetrieve({ endDate, mentorUniqueId, org, startDate, userId, }: {
1877
- endDate: string;
1878
- mentorUniqueId: string;
1879
- org: string;
1880
- startDate: string;
1881
- }): CancelablePromise<Cost>;
1882
- /**
1883
- * Retrieve the most discussed topics over time.
1884
- *
1885
- * This endpoint returns data on the frequency of topics discussed in conversations
1886
- * within a specified date range, with options for filtering by mentor and
1887
- * aggregating by different time periods (hourly, daily, weekly).
1888
- *
1889
- * Args:
1890
- * request: The HTTP request containing filter query parameters.
1891
- * org: Organization key identifier.
1892
- *
1893
- * Returns:
1894
- * Response: List of topics with their conversation counts, ordered by frequency.
1895
- *
1896
- * Raises:
1897
- * NotFound: If the specified organization does not exist.
1898
- * BadRequest: If the provided parameters are invalid.
1899
- *
1900
- * Query Parameters:
1901
- * start_date (str): Start date for filtering (YYYY-MM-DD) - required.
1902
- * end_date (str): End date for filtering (YYYY-MM-DD) - required.
1903
- * mentor_id (str): Filter by mentor unique ID.
1904
- * aggregation (str): Time aggregation level (hourly, daily, weekly) - default: daily.
1905
- * @returns TopicRecord
1906
- * @throws ApiError
1907
- */
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>>;
1929
- /**
1930
- * Retrieve an overview of key analytics metrics.
1931
- *
1932
- * This endpoint returns a comprehensive overview of key analytics metrics
1933
- * for an organization, including:
1934
- * - Conversation volume: Total sessions and month-over-month change
1935
- * - Users: Total unique users and month-over-month change
1936
- * - Topics: Total unique topics and month-over-month change
1937
- * - User ratings: Total ratings and month-over-month change
1938
- *
1939
- * Results can be filtered by mentor.
1940
- *
1941
- * Args:
1942
- * request: The HTTP request containing filter query parameters.
1943
- * org: Organization key identifier.
1944
- * user_id: User identifier (not used in the implementation).
1945
- *
1946
- * Returns:
1947
- * Response: Overview of key analytics metrics with month-over-month changes.
1948
- *
1949
- * Raises:
1950
- * NotFound: If the specified organization does not exist.
1951
- *
1952
- * Query Parameters:
1953
- * mentor_id (str): Filter analytics by mentor unique ID.
1954
- * @returns AnalyticsOverview
1955
- * @throws ApiError
1956
- */
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>;
1964
- /**
1965
- * Retrieve user rating metrics over time.
1966
- *
1967
- * This endpoint returns data on the number of user ratings submitted
1968
- * within a specified date range, aggregated by day or hour.
1969
- *
1970
- * Args:
1971
- * request: The HTTP request containing filter query parameters.
1972
- * org: Organization key identifier.
1973
- *
1974
- * Returns:
1975
- * Response: Time series of rating counts aggregated by day or hour.
1976
- *
1977
- * Raises:
1978
- * NotFound: If the specified organization does not exist.
1979
- * BadRequest: If the provided parameters are invalid.
1980
- *
1981
- * Query Parameters:
1982
- * start_date (str): Start date for filtering (YYYY-MM-DD) - required.
1983
- * end_date (str): End date for filtering (YYYY-MM-DD) - required.
1984
- * group_by (str): Aggregation level (day or hour) - default: day.
1985
- * @returns RatingRecord
1986
- * @throws ApiError
1987
- */
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>>;
2004
- /**
2005
- * Retrieve trends of registered users over time.
2006
- *
2007
- * This endpoint returns data on the number of new user registrations
2008
- * within a specified date range, with options for different time aggregations
2009
- * (hourly, daily, weekly, monthly). The data is backfilled to ensure
2010
- * continuous time series even for periods with zero registrations.
2011
- *
2012
- * Args:
2013
- * request: The HTTP request containing filter query parameters.
2014
- * org: Organization key identifier.
2015
- *
2016
- * Returns:
2017
- * Response: Time series of user registration counts.
2018
- *
2019
- * Raises:
2020
- * NotFound: If the specified organization does not exist.
2021
- * BadRequest: If the provided parameters are invalid.
2022
- *
2023
- * Query Parameters:
2024
- * start_date (str): Start date for filtering (YYYY-MM-DD) - required.
2025
- * end_date (str): End date for filtering (YYYY-MM-DD) - required.
2026
- * aggregation (str): Time aggregation level (hourly, daily, weekly, monthly) - default: daily.
2027
- * @returns TrendEntry
2028
- * @throws ApiError
2029
- */
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>>;
2047
- /**
2048
- * Retrieve user sentiment counts over time.
2049
- *
2050
- * This endpoint returns data on the number of user sentiment entries
2051
- * within a specified time period, aggregated by date.
2052
- *
2053
- * Args:
2054
- * request: The HTTP request containing filter query parameters.
2055
- * org: Organization key identifier.
2056
- * user_id: User identifier.
2057
- *
2058
- * Returns:
2059
- * Response: Time series data of sentiment counts.
2060
- *
2061
- * Raises:
2062
- * NotFound: If the specified organization does not exist.
2063
- * ValidationError: If the provided query parameters are invalid.
2064
- *
2065
- * Query Parameters:
2066
- * period (str): Time period filter (today, yesterday, 7d, 30d, 90d) - default: 7d.
2067
- * @returns UserSentimentCountView
2068
- * @throws ApiError
2069
- */
2070
- static aiAnalyticsOrgsUsersSentimentCountList({ org, userId, period, }: {
2071
- org: string;
2072
- period?: string;
2073
- }): CancelablePromise<Array<UserSentimentCountView>>;
2074
- /**
2075
- * Retrieve LLM usage costs for a specific tenant.
2076
- *
2077
- * This endpoint returns data on the total cost of LLM usage for a specific tenant
2078
- * within a specified date range. The cost is calculated by summing the costs
2079
- * of all observations associated with traces from the tenant's sessions.
2080
- *
2081
- * Args:
2082
- * request: The HTTP request containing filter query parameters.
2083
- * org: Organization key identifier.
2084
- *
2085
- * Returns:
2086
- * Response: Total LLM usage cost for the specified tenant.
2087
- *
2088
- * Raises:
2089
- * NotFound: If the specified organization does not exist.
2090
- * BadRequest: If the provided parameters are invalid.
2091
- *
2092
- * Query Parameters:
2093
- * start_date (str): Start date for filtering (YYYY-MM-DD) - required.
2094
- * end_date (str): End date for filtering (YYYY-MM-DD) - required.
2095
- * @returns Cost
2096
- * @throws ApiError
2097
- */
2098
- static aiAnalyticsOrgsUsersTenantCostRetrieve({ endDate, org, startDate, userId, }: {
2099
- endDate: string;
2100
- org: string;
2101
- startDate: string;
2102
- }): CancelablePromise<Cost>;
2103
- /**
2104
- * Retrieve the most engaged students based on chat message count.
2105
- *
2106
- * This endpoint returns data on the top 20 students with the highest number of
2107
- * chat messages, with optional filtering by mentor and date range.
2108
- *
2109
- * Args:
2110
- * request: The HTTP request containing filter query parameters.
2111
- * org: Organization key identifier.
2112
- * user_id: User identifier (not used in the implementation).
2113
- *
2114
- * Returns:
2115
- * Response: List of top students with their chat message counts.
2116
- *
2117
- * Raises:
2118
- * NotFound: If the specified organization does not exist.
2119
- * BadRequest: If the provided parameters are invalid.
2120
- *
2121
- * Query Parameters:
2122
- * mentor_id (str): Filter by mentor unique ID.
2123
- * start_date (str): Start date for filtering (YYYY-MM-DD).
2124
- * end_date (str): End date for filtering (YYYY-MM-DD).
2125
- * @returns StudentChatMessage
2126
- * @throws ApiError
2127
- */
2128
- static aiAnalyticsOrgsUsersTopStudentsByChatMessagesList({ org, userId, groupBy, }: {
2129
- org: string;
2130
- groupBy?: string;
2131
- }): CancelablePromise<Array<StudentChatMessage>>;
2132
- /**
2133
- * Retrieve aggregated topic statistics.
2134
- *
2135
- * This endpoint returns statistical information about topics within an organization,
2136
- * including total topics, new topics, and percentage changes compared to the
2137
- * previous month. Results can be filtered by mentor.
2138
- *
2139
- * Args:
2140
- * request: The HTTP request containing filter query parameters.
2141
- * org: Organization key identifier.
2142
- *
2143
- * Returns:
2144
- * Response: Statistical information about topics.
2145
- *
2146
- * Raises:
2147
- * NotFound: If the specified organization or mentor does not exist.
2148
- *
2149
- * Query Parameters:
2150
- * mentor_id (str): Filter statistics by mentor unique ID.
2151
- * @returns TopicStatisticsResponse
2152
- * @throws ApiError
2153
- */
2154
- static aiAnalyticsOrgsUsersTopicOverviewRetrieve({ org, userId, mentorId, }: {
2155
- org: string; /**
2156
- * Filter statistics by mentor unique ID
2157
- */
2158
- mentorId?: string;
2159
- }): CancelablePromise<TopicStatisticsResponse>;
2160
- /**
2161
- * Retrieve paginated statistics about topics.
2162
- *
2163
- * This endpoint returns detailed statistics about topics, including:
2164
- * - Number of conversations related to each topic
2165
- * - Total message count for each topic
2166
- * - Average sentiment of conversations about each topic
2167
- * - Average user rating for conversations about each topic
2168
- *
2169
- * Results can be filtered by mentor and date range, and are paginated.
2170
- *
2171
- * Args:
2172
- * request: The HTTP request containing filter query parameters.
2173
- * org: Organization key identifier.
2174
- *
2175
- * Returns:
2176
- * Response: Paginated list of topic statistics.
2177
- *
2178
- * Raises:
2179
- * NotFound: If the specified organization or mentor does not exist.
2180
- * BadRequest: If the provided parameters are invalid.
2181
- *
2182
- * Query Parameters:
2183
- * start_date (str): Start date for filtering (YYYY-MM-DD).
2184
- * end_date (str): End date for filtering (YYYY-MM-DD).
2185
- * mentor_id (str): Filter by mentor unique ID.
2186
- * page (int): Page number for pagination - default: 1.
2187
- * page_size (int): Number of results per page - default: 20.
2188
- * @returns PaginatedTopicStatisticsResponse
2189
- * @throws ApiError
2190
- */
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>;
2214
- /**
2215
- * Retrieve a summary of the most frequent topics.
2216
- *
2217
- * This endpoint returns a summary of the top 10 topics discussed in chat sessions,
2218
- * ordered by conversation count. Results can be filtered by mentor and date range.
2219
- *
2220
- * Args:
2221
- * request: The HTTP request containing filter query parameters.
2222
- * org: Organization key identifier.
2223
- *
2224
- * Returns:
2225
- * Response: A list of the top 10 topics with their conversation counts.
2226
- *
2227
- * Raises:
2228
- * NotFound: If the specified organization does not exist.
2229
- * BadRequest: If the provided date format is invalid.
2230
- *
2231
- * Query Parameters:
2232
- * mentor_id (str): Filter by mentor unique ID.
2233
- * start_date (str): Start date for filtering (YYYY-MM-DD).
2234
- * end_date (str): End date for filtering (YYYY-MM-DD).
2235
- * @returns TopicSummaryView
2236
- * @throws ApiError
2237
- */
2238
- static aiAnalyticsOrgsUsersTopicsSummaryList({ org, userId, endDate, startDate, }: {
2239
- org: string;
2240
- endDate?: string;
2241
- startDate?: string;
2242
- }): CancelablePromise<Array<TopicSummaryView>>;
2243
- /**
2244
- * Retrieve the total number of users interacting with mentors over time.
2245
- *
2246
- * This endpoint returns data on the number of unique users who interacted with
2247
- * mentors each day or hour within a specified date range, with optional
2248
- * filtering by specific mentor. If no date range is provided, the last 30 days
2249
- * are used by default.
2250
- *
2251
- * Args:
2252
- * request: The HTTP request containing filter query parameters.
2253
- * org: Organization key identifier.
2254
- *
2255
- * Returns:
2256
- * Response: Time series of unique user counts.
2257
- *
2258
- * Raises:
2259
- * NotFound: If the specified organization or mentor does not exist.
2260
- * BadRequest: If the provided parameters are invalid.
2261
- *
2262
- * Query Parameters:
2263
- * start_date (str): Start date for filtering (YYYY-MM-DD) - defaults to 30 days ago.
2264
- * end_date (str): End date for filtering (YYYY-MM-DD) - defaults to today.
2265
- * aggregation (str): Time aggregation level (hourly, daily) - default: daily.
2266
- * mentor_id (str): Filter by mentor unique ID.
2267
- * @returns UserChatByPeriod
2268
- * @throws ApiError
2269
- */
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>>;
2289
- /**
2290
- * Retrieve message data from conversations.
2291
- *
2292
- * This endpoint returns data on messages within conversations, with options
2293
- * for filtering by date range, topics, and mentor.
2294
- *
2295
- * Args:
2296
- * request: The HTTP request containing filter query parameters.
2297
- * org: Organization key identifier.
2298
- * user_id: User identifier (not used in the implementation).
2299
- *
2300
- * Returns:
2301
- * Response: A list of conversation message data.
2302
- *
2303
- * Raises:
2304
- * NotFound: If the specified organization does not exist.
2305
- * ValidationError: If the provided query parameters are invalid.
2306
- *
2307
- * Query Parameters:
2308
- * start_date (str): Start date for filtering (YYYY-MM-DD).
2309
- * end_date (str): End date for filtering (YYYY-MM-DD).
2310
- * topics (str): Comma-separated list of topics to filter by.
2311
- * mentor (str): Filter by mentor unique ID.
2312
- * @returns ConversationMessage
2313
- * @throws ApiError
2314
- */
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>>;
2322
- /**
2323
- * Retrieve daily user engagement metrics with mentors.
2324
- *
2325
- * This endpoint returns data on the number of unique users who interact with
2326
- * mentors each day within a specified date range.
2327
- *
2328
- * Args:
2329
- * request: The HTTP request containing filter query parameters.
2330
- * org: Organization key identifier.
2331
- *
2332
- * Returns:
2333
- * Response: Daily time series of unique user counts.
2334
- *
2335
- * Raises:
2336
- * NotFound: If the specified organization does not exist.
2337
- * BadRequest: If the provided parameters are invalid.
2338
- *
2339
- * Query Parameters:
2340
- * start_date (str): Start date for filtering (YYYY-MM-DD) - required.
2341
- * end_date (str): End date for filtering (YYYY-MM-DD) - required.
2342
- * @returns UserCountRecord
2343
- * @throws ApiError
2344
- */
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>>;
2358
- /**
2359
- * Retrieve user cohort trends over time.
2360
- *
2361
- * This endpoint returns data on the distribution of new versus veteran users
2362
- * over time, with options for different time aggregations and filtering by mentor.
2363
- * New users are those who registered within the specified date range, while
2364
- * veteran users are those who registered before the date range but were active
2365
- * during it.
2366
- *
2367
- * Args:
2368
- * request: The HTTP request containing filter query parameters.
2369
- * org: Organization key identifier.
2370
- *
2371
- * Returns:
2372
- * Response: Time series of new and veteran user counts.
2373
- *
2374
- * Raises:
2375
- * NotFound: If the specified organization does not exist.
2376
- * BadRequest: If the provided parameters are invalid.
2377
- *
2378
- * Query Parameters:
2379
- * start_date (str): Start date for filtering (YYYY-MM-DD) - required.
2380
- * end_date (str): End date for filtering (YYYY-MM-DD) - required.
2381
- * aggregation (str): Time aggregation level (hourly, daily, weekly) - default: daily.
2382
- * mentor_id (str): Filter by mentor unique ID.
2383
- * @returns UserTrendByPeriod
2384
- * @throws ApiError
2385
- */
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>;
2406
- /**
2407
- * Retrieve LLM usage costs for a specific user.
2408
- *
2409
- * This endpoint returns data on the total cost of LLM usage for a specific user
2410
- * within a specified date range. The cost is calculated by summing the costs
2411
- * of all observations associated with traces from the tenant's sessions.
2412
- *
2413
- * Args:
2414
- * request: The HTTP request containing filter query parameters.
2415
- * org: Organization key identifier.
2416
- * user_id: User key identifier.
2417
- *
2418
- * Returns:
2419
- * Response: Total LLM usage cost for the specified tenant.
2420
- *
2421
- * Raises:
2422
- * NotFound: If the specified organization does not exist.
2423
- * BadRequest: If the provided parameters are invalid.
2424
- *
2425
- * Query Parameters:
2426
- * start_date (str): Start date for filtering (YYYY-MM-DD) - required.
2427
- * end_date (str): End date for filtering (YYYY-MM-DD) - required.
2428
- * @returns Cost
2429
- * @throws ApiError
2430
- */
2431
- static aiAnalyticsOrgsUsersUserCostRetrieve({ endDate, org, startDate, userId, username, }: {
2432
- endDate: string;
2433
- org: string;
2434
- startDate: string;
2435
- username: string;
2436
- }): CancelablePromise<Cost>;
2437
- /**
2438
- * Retrieve aggregated user chat feedback counts.
2439
- *
2440
- * This endpoint returns data on the number of user chat feedback entries
2441
- * within a specified date range, with options for different time aggregations
2442
- * (hourly, daily, weekly). Results can be filtered by mentor.
2443
- *
2444
- * Args:
2445
- * request: The HTTP request containing filter query parameters.
2446
- * org: Organization key identifier.
2447
- *
2448
- * Returns:
2449
- * Response: Time series data of feedback counts.
2450
- *
2451
- * Raises:
2452
- * NotFound: If the specified organization does not exist.
2453
- * BadRequest: If the provided parameters are invalid.
2454
- *
2455
- * Query Parameters:
2456
- * start_date (str): Start date for filtering (YYYY-MM-DD) - required.
2457
- * end_date (str): End date for filtering (YYYY-MM-DD) - required.
2458
- * mentor_id (str): Filter by mentor unique ID.
2459
- * aggregation (str): Time aggregation level (hourly, daily, weekly) - default: daily.
2460
- * @returns UserChatFeedbackCount
2461
- * @throws ApiError
2462
- */
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>>;
2483
- /**
2484
- * Retrieve comprehensive user metrics.
2485
- *
2486
- * This endpoint returns data on various user metrics with month-over-month
2487
- * change calculations:
2488
- * - Registered users: Total users registered on the platform
2489
- * - New users: Users who joined in the current month
2490
- * - Unique users: Distinct users who have had sessions
2491
- * - Veteran users: Users who have been active for at least 6 months
2492
- *
2493
- * Results can be filtered by mentor.
2494
- *
2495
- * Args:
2496
- * request: The HTTP request containing filter query parameters.
2497
- * org: Organization key identifier.
2498
- *
2499
- * Returns:
2500
- * Response: Comprehensive user metrics with month-over-month changes.
2501
- *
2502
- * Raises:
2503
- * NotFound: If the specified organization does not exist.
2504
- *
2505
- * Query Parameters:
2506
- * mentor_id (str): Filter metrics by mentor unique ID.
2507
- * @returns UserMetricsResponse
2508
- * @throws ApiError
2509
- */
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>;
2517
- /**
2518
- * Retrieve user distribution data for pie charts.
2519
- *
2520
- * This endpoint returns data on the distribution of new versus returning users
2521
- * within a specified date range, including both counts and percentages,
2522
- * suitable for pie chart visualization.
2523
- *
2524
- * Args:
2525
- * request: The HTTP request containing filter query parameters.
2526
- * org: Organization key identifier.
2527
- *
2528
- * Returns:
2529
- * Response: Distribution of new versus returning users with counts and percentages.
2530
- *
2531
- * Raises:
2532
- * NotFound: If the specified organization does not exist.
2533
- * BadRequest: If the provided parameters are invalid.
2534
- *
2535
- * Query Parameters:
2536
- * start_date (str): Start date for filtering (YYYY-MM-DD) - required.
2537
- * end_date (str): End date for filtering (YYYY-MM-DD) - required.
2538
- * mentor_id (str): Filter by mentor unique ID.
2539
- * @returns PieChartData
2540
- * @throws ApiError
2541
- */
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>;
2558
- /**
2559
- * Retrieve user sentiment distribution.
2560
- *
2561
- * This endpoint returns data on the distribution of user sentiments (positive,
2562
- * negative, neutral) within a specified date range, expressed as percentages.
2563
- *
2564
- * Args:
2565
- * request: The HTTP request containing filter query parameters.
2566
- * org: Organization key identifier.
2567
- *
2568
- * Returns:
2569
- * Response: Sentiment distribution percentages and total sentiment count.
2570
- *
2571
- * Raises:
2572
- * NotFound: If the specified organization does not exist.
2573
- * BadRequest: If the provided parameters are invalid.
2574
- *
2575
- * Query Parameters:
2576
- * start_date (str): Start date for filtering (YYYY-MM-DD) - required.
2577
- * end_date (str): End date for filtering (YYYY-MM-DD) - required.
2578
- * @returns SentimentSummary
2579
- * @throws ApiError
2580
- */
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>;
2594
- /**
2595
- * Get active user counts over time.
2596
- *
2597
- * This endpoint provides daily counts of active users (users with known activity)
2598
- * over a specified time period.
2599
- *
2600
- * Query Parameters:
2601
- * start_date (str, optional): Start date for the time range (ISO format)
2602
- * end_date (str, optional): End date for the time range (ISO format)
2603
- *
2604
- * Returns:
2605
- * Daily active user counts over the specified time period, with change metrics
2606
- * compared to previous periods.
2607
- *
2608
- * Default time range is the last 7 days if no dates are specified.
2609
- *
2610
- * An active user is defined as a user with any activity within the past 30 days.
2611
- * @returns OvertimeWithChangeInfo
2612
- * @throws ApiError
2613
- */
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>;
2639
- /**
2640
- * Get average grade value for platform, course, or user.
2641
- *
2642
- * This endpoint returns the average grade at different levels:
2643
- * - Platform level: Average grade across all courses
2644
- * - Course level: Average grade for a specific course
2645
- * - Learner level: Average grade for a specific learner
2646
- * - Course-learner level: Grade for a specific learner in a specific course
2647
- *
2648
- * Query Parameters:
2649
- * course_id (str, optional): Filter by course ID
2650
- * learner_id (str, optional): Filter by username or email
2651
- *
2652
- * Returns:
2653
- * The average grade value based on the specified filters.
2654
- *
2655
- * Access Control:
2656
- * - Platform admins can access any grade data
2657
- * - Learners can access their own grade data
2658
- * @returns Average
2659
- * @throws ApiError
2660
- */
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>;
2678
- /**
2679
- * Get course completion summary metrics over time.
2680
- *
2681
- * This endpoint provides completion statistics across the platform over a
2682
- * specified time period, including daily completion counts and overall metrics.
2683
- *
2684
- * Query Parameters:
2685
- * start_date (str): Start date for the time range (ISO format)
2686
- * end_date (str): End date for the time range (ISO format)
2687
- *
2688
- * Returns:
2689
- * Completion data including:
2690
- * - Daily completion counts over time
2691
- * - Total unique user count
2692
- * - Total completion count
2693
- * - Completion percentage
2694
- * - Change metrics compared to previous periods
2695
- *
2696
- * Default time range is the last 7 days if no dates are specified.
2697
- * @returns CourseCompletionSummaryOvertime
2698
- * @throws ApiError
2699
- */
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>;
2725
- /**
2726
- * List all learners on the platform with aggregated metrics.
2727
- *
2728
- * This endpoint returns a paginated list of all learners with key metrics including:
2729
- * - Enrollment counts
2730
- * - Completion counts
2731
- * - Time spent on platform
2732
- *
2733
- * Query Parameters:
2734
- * page (int): Page number for pagination
2735
- * length (int): Number of items per page
2736
- * search (str): Filter learners by username, email, or name
2737
- *
2738
- * Returns:
2739
- * A paginated list of learners with their associated metrics.
2740
- * @returns PerlearnerUserList
2741
- * @throws ApiError
2742
- */
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>;
2772
- /**
2773
- * Get time spent statistics on a per-course basis.
2774
- *
2775
- * This endpoint provides a paginated list of courses with the total time
2776
- * spent by users in each course.
2777
- *
2778
- * Query Parameters:
2779
- * start_date (str, optional): Start date for filtering (ISO format)
2780
- * end_date (str, optional): End date for filtering (ISO format)
2781
- * page (int, optional): Page number for pagination
2782
- * length (int, optional): Number of items per page
2783
- *
2784
- * Returns:
2785
- * A paginated list of courses with:
2786
- * - Course identification (ID and name)
2787
- * - Total time spent (in seconds)
2788
- * - Formatted time spent (human-readable)
2789
- * - Percentage of total platform time
2790
- * @returns TimeSpentPerCourse
2791
- * @throws ApiError
2792
- */
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>;
2826
- /**
2827
- * Get registered user counts over time.
2828
- *
2829
- * This endpoint provides daily counts of new user registrations over a
2830
- * specified time period.
2831
- *
2832
- * Query Parameters:
2833
- * start_date (str, optional): Start date for the time range (ISO format)
2834
- * end_date (str, optional): End date for the time range (ISO format)
2835
- *
2836
- * Returns:
2837
- * Daily registration counts over the specified time period, with change metrics
2838
- * compared to previous periods.
2839
- *
2840
- * Default time range is the last 7 days if no dates are specified.
2841
- * @returns OvertimeWithChangeInfo
2842
- * @throws ApiError
2843
- */
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>;
2869
- /**
2870
- * Get average grade value for platform, course, or user.
2871
- *
2872
- * This endpoint returns the average grade at different levels:
2873
- * - Platform level: Average grade across all courses
2874
- * - Course level: Average grade for a specific course
2875
- * - Learner level: Average grade for a specific learner
2876
- * - Course-learner level: Grade for a specific learner in a specific course
2877
- *
2878
- * Query Parameters:
2879
- * course_id (str, optional): Filter by course ID
2880
- * learner_id (str, optional): Filter by username or email
2881
- *
2882
- * Returns:
2883
- * The average grade value based on the specified filters.
2884
- *
2885
- * Access Control:
2886
- * - Platform admins can access any grade data
2887
- * - Learners can access their own grade data
2888
- * @returns Average
2889
- * @throws ApiError
2890
- */
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>;
2909
- /**
2910
- * Returns average course grade and grade cuttoff
2911
- *
2912
- * e.g
2913
- * ```
2914
- * {
2915
- * "data": {
2916
- * "grade_cutoffs": {
2917
- * "A": 90,
2918
- * "B": 80,
2919
- * "C": 70,
2920
- * },
2921
- * "average_grade": 50.0,
2922
- * }
2923
- * }
2924
- * ```
2925
- *
2926
- * Kwargs
2927
- * course_id
2928
- * @returns AvgCourseGradeWithCutoff
2929
- * @throws ApiError
2930
- */
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>;
2949
- /**
2950
- * Grading summary for the entire course overview in a tree-like format
2951
- *
2952
- * Kwargs
2953
- * course_id <required>
2954
- * @returns CourseGradingDetail
2955
- * @throws ApiError
2956
- */
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>;
2975
- /**
2976
- * Grading information per enrolled user in a course
2977
- *
2978
- * Kwargs
2979
- * course_id <required>
2980
- * @returns GradingPerUser
2981
- * @throws ApiError
2982
- */
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>;
3001
- /**
3002
- * Returns average grades across various assignment types in a course
3003
- *
3004
- * Query Params
3005
- * course_id
3006
- *
3007
- * Returns:
3008
- * dict
3009
- * {
3010
- * "data": [
3011
- * {
3012
- * "assignment_type': <str>,
3013
- * "weight": <float>,
3014
- * "average_weighted_grade": <float>,
3015
- * "average_section_grade": <float>
3016
- * }, ...
3017
- * ]
3018
- * }
3019
- * @returns CourseGradeSummary
3020
- * @throws ApiError
3021
- */
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>;
3040
- /**
3041
- * Get average grade value for platform, course, or user.
3042
- *
3043
- * This endpoint returns the average grade at different levels:
3044
- * - Platform level: Average grade across all courses
3045
- * - Course level: Average grade for a specific course
3046
- * - Learner level: Average grade for a specific learner
3047
- * - Course-learner level: Grade for a specific learner in a specific course
3048
- *
3049
- * Query Parameters:
3050
- * course_id (str, optional): Filter by course ID
3051
- * learner_id (str, optional): Filter by username or email
3052
- *
3053
- * Returns:
3054
- * The average grade value based on the specified filters.
3055
- *
3056
- * Access Control:
3057
- * - Platform admins can access any grade data
3058
- * - Learners can access their own grade data
3059
- * @returns Average
3060
- * @throws ApiError
3061
- */
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>;
3079
- /**
3080
- * List grade-related performance data for all courses.
3081
- *
3082
- * This endpoint provides a comprehensive view of grade performance across
3083
- * courses, including enrollment counts, pass rates, and average grades.
3084
- *
3085
- * Returns:
3086
- * A paginated list of courses with:
3087
- * - Course identification (ID and name)
3088
- * - Enrollment count
3089
- * - Number of students who passed
3090
- * - Average grade
3091
- * @returns PerformanceGradesPerCourse
3092
- * @throws ApiError
3093
- */
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>;
3119
- /**
3120
- * Enhanced API endpoint for listing learners with comprehensive filtering.
3121
- *
3122
- * This endpoint provides a paginated list of learners with detailed metrics
3123
- * and supports advanced filtering options. It uses DM token authentication
3124
- * and respects department-based access controls.
3125
- *
3126
- * Query Parameters:
3127
- * page (int): Page number for pagination
3128
- * length (int): Number of items per page
3129
- * search (str): Filter by username, email, or full name
3130
- * program (str): Filter by program
3131
- * location (str): Filter by location
3132
- * is_enrolled (bool): Filter for users with enrollments
3133
- * platform (str): Filter by platform
3134
- * start_date (date): Filter by join date (start range)
3135
- * end_date (date): Filter by join date (end range)
3136
- *
3137
- * Returns:
3138
- * A paginated list of learners with comprehensive metrics including:
3139
- * - Course enrollments and completions
3140
- * - Time spent on platform
3141
- * - Pathway progress
3142
- * - Certificate and skill information
3143
- * - Location data
3144
- *
3145
- * Access Control:
3146
- * - Platform admins can see all learners
3147
- * - Department admins can only see learners in their departments
3148
- * @returns NewPerLearnerList
3149
- * @throws ApiError
3150
- */
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>;
3204
- /**
3205
- * List all learners on the platform with aggregated metrics.
3206
- *
3207
- * This endpoint returns a paginated list of all learners with key metrics including:
3208
- * - Enrollment counts
3209
- * - Completion counts
3210
- * - Time spent on platform
3211
- *
3212
- * Query Parameters:
3213
- * page (int): Page number for pagination
3214
- * length (int): Number of items per page
3215
- * search (str): Filter learners by username, email, or name
3216
- *
3217
- * Returns:
3218
- * A paginated list of learners with their associated metrics.
3219
- * @returns PerlearnerUserList
3220
- * @throws ApiError
3221
- */
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>;
3251
- /**
3252
- * Provides information on user enrollments
3253
- *
3254
- * Params
3255
- * user_id e.g developer@ibleducation.com| developer
3256
- * @returns ActivityAPI
3257
- * @throws ApiError
3258
- */
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>;
3273
- /**
3274
- * Provides about a learner current grade in a course with the course cut
3275
- * Kwargs
3276
- * 1. course_id e.g course-v1:Org+Course4+Run
3277
- * 2. user_id e.g developer@ibleducation.com or dev123 (username|email)
3278
- * @returns PerlearnerGradeWithCutOff
3279
- * @throws ApiError
3280
- */
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>;
3302
- /**
3303
- * Mixin that includes the StudentTokenAuthentication and IsAdminUserOrStudent
3304
- * @returns DetailedGradeView
3305
- * @throws ApiError
3306
- */
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>;
3328
- /**
3329
- * Query Params
3330
- * 1. course_id e.g course-v1:Org+Course4+Run
3331
- * 2. user_id e.g developer@ibleducation.com or dev123 (username|email)
3332
- * @returns PerlearnerGradeSummary
3333
- * @throws ApiError
3334
- */
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>;
3356
- /**
3357
- * Average of days with atleast an activity within ENGAGEMENT_INDEX_PERIOD consecutive days for a learner in a course
3358
- * @returns Value
3359
- * @throws ApiError
3360
- */
3361
- static aiAnalyticsPerlearnerOrgsUsersCoursesOverviewEngagementIndexRetrieve({ courseId, org, userId, }: {
3362
- courseId: string;
3363
- org: string;
3364
- }): CancelablePromise<Value>;
3365
- /**
3366
- * Provides about a learner current grade in a course with the course cut
3367
- * Kwargs
3368
- * 1. course_id e.g course-v1:Org+Course4+Run
3369
- * 2. user_id e.g developer@ibleducation.com or dev123 (username|email)
3370
- * @returns PerlearnerGradeWithCutOff
3371
- * @throws ApiError
3372
- */
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>;
3394
- /**
3395
- * Evaluates performance index for platform, per course, per user and per user-per course
3396
- *
3397
- * Query Params
3398
- * course_id <optional>
3399
- * learner_id <optional>
3400
- * @returns Value
3401
- * @throws ApiError
3402
- */
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>;
3424
- /**
3425
- * Time spent within a course in secs on a per-day basis
3426
- *
3427
- * Kwargs
3428
- * 1. course_id e.g course-v1:Org+Course4+Run
3429
- * 2. user_id e.g developer@ibleducation.com or dev123 (username|email)
3430
- * Query Params
3431
- * 3. start_date e.g 2020-10-01
3432
- * 4. end_date e.g 2020-10-10
3433
- *
3434
- * Default result when no query param is added is last_7_days (today inclusive)
3435
- * @returns OverTimeWithTotal
3436
- * @throws ApiError
3437
- */
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>;
3459
- /**
3460
- * List of videos within a course a learner has watched
3461
- *
3462
- * Kwargs
3463
- * 1. course_id e.g course-v1:Org+Course4+Run
3464
- * 2. user_id e.g developer@ibleducation.com or dev123 (username|email)
3465
- *
3466
- * Default result when no query param is added is [], 0
3467
- * @returns PerLearnerCourseVideosWatched
3468
- * @throws ApiError
3469
- */
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>;
3485
- /**
3486
- * Get video watch counts over time.
3487
- *
3488
- * This endpoint provides daily counts of videos watched over a specified time period,
3489
- * with options to filter by course or user.
3490
- *
3491
- * Query Parameters:
3492
- * start_date (str, optional): Start date for the time range (ISO format)
3493
- * end_date (str, optional): End date for the time range (ISO format)
3494
- * course_id (str, optional): Filter by course ID
3495
- * user_id (str, optional): Filter by username or email
3496
- *
3497
- * Returns:
3498
- * Daily video watch counts over the specified time period.
3499
- *
3500
- * Default time range is the last 7 days if no dates are specified.
3501
- *
3502
- * Access Control:
3503
- * - Platform admins can access any video watch data
3504
- * - Learners can access their own video watch data
3505
- * @returns OverTimeWithTotal
3506
- * @throws ApiError
3507
- */
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>;
3529
- /**
3530
- * Summary Grading Information for a learner on a per-enrollment basis
3531
- *
3532
- * Query Params
3533
- * 1. user_id e.g developer@ibleducation.com or dev123 (username|email)
3534
- * @returns PerlearnerGradingPerCourseAPI
3535
- * @throws ApiError
3536
- */
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>;
3551
- /**
3552
- * Retrieve detailed information about a specific learner.
3553
- *
3554
- * This endpoint returns personal and activity information about a learner,
3555
- * including profile data, activity metrics, and location information.
3556
- *
3557
- * Path Parameters:
3558
- * user_id (str): The username or email of the learner
3559
- *
3560
- * Query Parameters:
3561
- * meta (bool): Include additional analytics information when true
3562
- *
3563
- * Returns:
3564
- * Detailed learner information including:
3565
- * - Profile data (username, name, email)
3566
- * - Registration and activity dates
3567
- * - Activity metrics (assessments, time spent, videos watched)
3568
- * - Location and browser information (when available)
3569
- *
3570
- * Access Control:
3571
- * - Platform admins can access any learner
3572
- * - Learners can access their own information
3573
- * - Department admins can access learners in their departments
3574
- * @returns LearnerInformationAPI
3575
- * @throws ApiError
3576
- */
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>;
3604
- /**
3605
- * Last course accessed by a learner, includes upto unit information as well
3606
- * @returns PerLearnerLastAccess
3607
- * @throws ApiError
3608
- */
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>;
3623
- /**
3624
- * Average of days with atleast an activity within ENGAGEMENT_INDEX_PERIOD consecutive days
3625
- * @returns Value
3626
- * @throws ApiError
3627
- */
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>;
3648
- /**
3649
- * Get average grade value for platform, course, or user.
3650
- *
3651
- * This endpoint returns the average grade at different levels:
3652
- * - Platform level: Average grade across all courses
3653
- * - Course level: Average grade for a specific course
3654
- * - Learner level: Average grade for a specific learner
3655
- * - Course-learner level: Grade for a specific learner in a specific course
3656
- *
3657
- * Query Parameters:
3658
- * course_id (str, optional): Filter by course ID
3659
- * learner_id (str, optional): Filter by username or email
3660
- *
3661
- * Returns:
3662
- * The average grade value based on the specified filters.
3663
- *
3664
- * Access Control:
3665
- * - Platform admins can access any grade data
3666
- * - Learners can access their own grade data
3667
- * @returns Average
3668
- * @throws ApiError
3669
- */
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>;
3684
- /**
3685
- * Evaluates performance index for platform, per course, per user and per user-per course
3686
- *
3687
- * Query Params
3688
- * course_id <optional>
3689
- * learner_id <optional>
3690
- * @returns Value
3691
- * @throws ApiError
3692
- */
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>;
3713
- /**
3714
- * Time spent in secs on a per-day basis
3715
- *
3716
- * Query Params
3717
- * 1. course_id <optional> e.g course-v1:Org+Course4+Run
3718
- * 2. user_id <optional> e.g developer@ibleducation.com or dev123 (username|email)
3719
- * 3. start_date e.g 2020-10-01
3720
- * 4. end_date e.g 2020-10-10
3721
- *
3722
- * Default result when no query param is added is last_7_days (today inclusive)
3723
- * @returns OverTimeWithTotal
3724
- * @throws ApiError
3725
- */
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>;
3746
- /**
3747
- * Get video watch counts over time.
3748
- *
3749
- * This endpoint provides daily counts of videos watched over a specified time period,
3750
- * with options to filter by course or user.
3751
- *
3752
- * Query Parameters:
3753
- * start_date (str, optional): Start date for the time range (ISO format)
3754
- * end_date (str, optional): End date for the time range (ISO format)
3755
- * course_id (str, optional): Filter by course ID
3756
- * user_id (str, optional): Filter by username or email
3757
- *
3758
- * Returns:
3759
- * Daily video watch counts over the specified time period.
3760
- *
3761
- * Default time range is the last 7 days if no dates are specified.
3762
- *
3763
- * Access Control:
3764
- * - Platform admins can access any video watch data
3765
- * - Learners can access their own video watch data
3766
- * @returns OverTimeWithTotal
3767
- * @throws ApiError
3768
- */
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>;
3789
- /**
3790
- * Summary Videos watched data for a learner per enrollment
3791
- *
3792
- * Query Params
3793
- * 1. user_id e.g developer@ibleducation.com or dev123 (username|email)
3794
- * @returns PerlearnerEngagementVideosWatchedPerCourse
3795
- * @throws ApiError
3796
- */
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>;
3817
- /**
3818
- * Get a list of user groups with metrics and filtering options.
3819
- *
3820
- * This endpoint provides a paginated list of user groups with aggregated metrics
3821
- * about learner performance, course completions, and skill acquisition.
3822
- *
3823
- * This endpoint uses DM token authentication and respects department-based
3824
- * access controls.
3825
- *
3826
- * Query Parameters:
3827
- * page (int, optional): Page number for pagination
3828
- * length (int, optional): Number of items per page
3829
- * program (str, optional): Filter by program
3830
- * pathway (str, optional): Filter by pathway
3831
- * groups (list, optional): Filter by group names
3832
- * location (str, optional): Filter by location
3833
- * is_enrolled (bool, optional): Filter for groups with enrolled users
3834
- * start_date (date, optional): Filter by learner join date (start range)
3835
- * end_date (date, optional): Filter by learner join date (end range)
3836
- *
3837
- * Returns:
3838
- * A paginated list of user groups with comprehensive metrics.
3839
- *
3840
- * Access Control:
3841
- * - Platform admins can see all groups
3842
- * - Department admins can only see groups in their departments
3843
- * @returns GroupList
3844
- * @throws ApiError
3845
- */
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>;
3899
- }