@iblai/iblai-api 3.54.5-core → 3.55.0-ai-plus

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