@iblai/iblai-api 4.23.1-ai → 4.23.2-test-core

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