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