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