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