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