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