@iblai/iblai-api 4.23.0-core → 4.23.0-test-ai

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