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