@iblai/iblai-api 2025.11.13-teams-bot-renovation-ai → 2025.11.13-teams-bot-renovation-3-core
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.cjs.js +3147 -25021
- package/dist/index.cjs.js.map +1 -1
- package/dist/index.esm.js +3148 -25013
- package/dist/index.esm.js.map +1 -1
- package/dist/index.umd.js +3147 -25021
- package/dist/index.umd.js.map +1 -1
- package/dist/types/index.d.ts +1 -421
- package/dist/types/models/{StripeCheckoutSessionRequestModeEnum.d.ts → ModeEnum.d.ts} +1 -1
- package/dist/types/models/Pagination.d.ts +11 -16
- package/dist/types/models/StripeCheckoutSessionRequest.d.ts +2 -2
- package/dist/types/services/AiAnalyticsService.d.ts +26 -4698
- package/dist/types/services/AnalyticsService.d.ts +4 -709
- package/dist/types/services/SearchService.d.ts +0 -738
- package/package.json +1 -1
- package/sdk_schema.yml +23548 -70793
- package/src/core/OpenAPI.ts +1 -1
- package/src/index.ts +1 -421
- package/src/models/{StripeCheckoutSessionRequestModeEnum.ts → ModeEnum.ts} +1 -1
- package/src/models/Pagination.ts +11 -16
- package/src/models/StripeCheckoutSessionRequest.ts +2 -2
- package/src/services/AiAnalyticsService.ts +5255 -12921
- package/src/services/AnalyticsService.ts +177 -1234
- package/src/services/SearchService.ts +398 -1459
- package/dist/types/models/AIGeneratedImage.d.ts +0 -13
- package/dist/types/models/AIUserProfileMemoryRelation.d.ts +0 -4
- package/dist/types/models/AIUserProfileRequest.d.ts +0 -4
- package/dist/types/models/AccessEnum.d.ts +0 -8
- package/dist/types/models/AccessTimesHeatmap.d.ts +0 -5
- package/dist/types/models/AccessibleMentorsByEmailRequest.d.ts +0 -13
- package/dist/types/models/AccessibleMentorsByEmailResponse.d.ts +0 -13
- package/dist/types/models/ActionBreakdown.d.ts +0 -10
- package/dist/types/models/AddMentorToDisclaimer.d.ts +0 -12
- package/dist/types/models/AlignMentorBubbleEnum.d.ts +0 -8
- package/dist/types/models/AnalyticsOverview.d.ts +0 -7
- package/dist/types/models/Answer.d.ts +0 -11
- package/dist/types/models/Artifact.d.ts +0 -56
- package/dist/types/models/ArtifactList.d.ts +0 -45
- package/dist/types/models/AssumedKnowledge.d.ts +0 -4
- package/dist/types/models/AssumedKnowledgeLevel.d.ts +0 -4
- package/dist/types/models/AudioToTextRequest.d.ts +0 -3
- package/dist/types/models/AudioToTextResponse.d.ts +0 -3
- package/dist/types/models/AuthTypeEnum.d.ts +0 -10
- package/dist/types/models/AutoMemoryPrompt.d.ts +0 -4
- package/dist/types/models/BaseFinanceResponse.d.ts +0 -37
- package/dist/types/models/BillingPeriod.d.ts +0 -8
- package/dist/types/models/Bot.d.ts +0 -15
- package/dist/types/models/BotCommand.d.ts +0 -6
- package/dist/types/models/BotCreate.d.ts +0 -12
- package/dist/types/models/Breakdown.d.ts +0 -11
- package/dist/types/models/CallAuthenticationRequest.d.ts +0 -17
- package/dist/types/models/CallAuthenticationResponse.d.ts +0 -21
- package/dist/types/models/CallConfiguration.d.ts +0 -26
- package/dist/types/models/CallConfigurationModeEnum.d.ts +0 -8
- package/dist/types/models/ChatHistory.d.ts +0 -9
- package/dist/types/models/ChatHistoryFilterData.d.ts +0 -9
- package/dist/types/models/ChatHistoryFilterUser.d.ts +0 -5
- package/dist/types/models/ChatHistoryItem.d.ts +0 -5
- package/dist/types/models/ChatHistorySessionId.d.ts +0 -3
- package/dist/types/models/ChatSessionRequest.d.ts +0 -15
- package/dist/types/models/ChatSessionResponse.d.ts +0 -6
- package/dist/types/models/CheckDocumentTrainingStatus.d.ts +0 -10
- package/dist/types/models/ComparisonInfo.d.ts +0 -29
- package/dist/types/models/ComponentBlock.d.ts +0 -9
- package/dist/types/models/ComponentBlockTypeEnum.d.ts +0 -8
- package/dist/types/models/ConnectedService.d.ts +0 -11
- package/dist/types/models/ConnectedServiceProviderEnum.d.ts +0 -6
- package/dist/types/models/ConversationChartPoint.d.ts +0 -4
- package/dist/types/models/ConversationDetailResponse.d.ts +0 -4
- package/dist/types/models/ConversationListItem.d.ts +0 -24
- package/dist/types/models/ConversationListResponse.d.ts +0 -6
- package/dist/types/models/ConversationMessage.d.ts +0 -11
- package/dist/types/models/ConversationRating.d.ts +0 -6
- package/dist/types/models/ConversationSummary.d.ts +0 -5
- package/dist/types/models/ConversationVolume.d.ts +0 -4
- package/dist/types/models/Conversations.d.ts +0 -33
- package/dist/types/models/ConversationsChart.d.ts +0 -5
- package/dist/types/models/Cost.d.ts +0 -3
- package/dist/types/models/CostPerTenant.d.ts +0 -6
- package/dist/types/models/CourseCreationTask.d.ts +0 -31
- package/dist/types/models/CourseCreationTaskFile.d.ts +0 -7
- package/dist/types/models/CourseCreationTaskStatusEnum.d.ts +0 -16
- package/dist/types/models/CourseRecommendation.d.ts +0 -45
- package/dist/types/models/CrawlerPatternTypeEnum.d.ts +0 -8
- package/dist/types/models/CredentialRequest.d.ts +0 -14
- package/dist/types/models/CrontabSchedule.d.ts +0 -22
- package/dist/types/models/CurrentUsersResponse.d.ts +0 -8
- package/dist/types/models/CustomInstructionResponse.d.ts +0 -13
- package/dist/types/models/DataSet.d.ts +0 -21
- package/dist/types/models/DataSetCreate.d.ts +0 -12
- package/dist/types/models/DataSetStatusEnum.d.ts +0 -12
- package/dist/types/models/DateRange.d.ts +0 -4
- package/dist/types/models/Disclaimer.d.ts +0 -17
- package/dist/types/models/DisclaimerAgreement.d.ts +0 -11
- package/dist/types/models/DiscordConfig.d.ts +0 -7
- package/dist/types/models/DiscordUserConfig.d.ts +0 -10
- package/dist/types/models/DiscordWebhook.d.ts +0 -6
- package/dist/types/models/Document.d.ts +0 -41
- package/dist/types/models/DocumentFacet.d.ts +0 -17
- package/dist/types/models/DocumentFromPoolRequest.d.ts +0 -10
- package/dist/types/models/DocumentSearchResponse.d.ts +0 -35
- package/dist/types/models/DocumentSettingsResponse.d.ts +0 -3
- package/dist/types/models/EdxCourse.d.ts +0 -11
- package/dist/types/models/ElevenlabsCustomVoice.d.ts +0 -4
- package/dist/types/models/ElevenlabsCustomVoiceResponse.d.ts +0 -8
- package/dist/types/models/EmailPromptDetail.d.ts +0 -13
- package/dist/types/models/EmailPromptList.d.ts +0 -11
- package/dist/types/models/EmailPromptSummary.d.ts +0 -5
- package/dist/types/models/Entity.d.ts +0 -11
- package/dist/types/models/EntityTypeEnum.d.ts +0 -10
- package/dist/types/models/ExternalServiceInfo.d.ts +0 -6
- package/dist/types/models/FileUploadURLRequest.d.ts +0 -21
- package/dist/types/models/FileUploadURLResponse.d.ts +0 -25
- package/dist/types/models/FinanceDetailsResponse.d.ts +0 -13
- package/dist/types/models/FinanceFilters.d.ts +0 -15
- package/dist/types/models/FreeUsageCount.d.ts +0 -3
- package/dist/types/models/FullCourse.d.ts +0 -13
- package/dist/types/models/GreetingMethodEnum.d.ts +0 -8
- package/dist/types/models/GuidedPrompt.d.ts +0 -4
- package/dist/types/models/GuidedPromptsResponse.d.ts +0 -5
- package/dist/types/models/HeygenMarketingVideoDetail.d.ts +0 -8
- package/dist/types/models/HeygenMarketingVideoList.d.ts +0 -6
- package/dist/types/models/HeygenTemplateRequest.d.ts +0 -5
- package/dist/types/models/HeygenTemplateResponseSingle.d.ts +0 -6
- package/dist/types/models/HeygenVideoDetail.d.ts +0 -8
- package/dist/types/models/HeygenVideoRequest.d.ts +0 -5
- package/dist/types/models/HumanSupportTicket.d.ts +0 -23
- package/dist/types/models/HumanSupportTicketStatusEnum.d.ts +0 -10
- package/dist/types/models/InputQuestion.d.ts +0 -6
- package/dist/types/models/IntegrationCredential.d.ts +0 -10
- package/dist/types/models/IntegrationCredentialSchema.d.ts +0 -6
- package/dist/types/models/IntialQuestionAnswer.d.ts +0 -3
- package/dist/types/models/InvoiceReportResponse.d.ts +0 -13
- package/dist/types/models/JobRun.d.ts +0 -11
- package/dist/types/models/KindEnum.d.ts +0 -10
- package/dist/types/models/LLMCredentialRequest.d.ts +0 -14
- package/dist/types/models/LLMCredentialResponse.d.ts +0 -10
- package/dist/types/models/LLMCredentialSchema.d.ts +0 -6
- package/dist/types/models/LLMModelForTenant.d.ts +0 -6
- package/dist/types/models/LLMQuestion.d.ts +0 -15
- package/dist/types/models/LLMResponse.d.ts +0 -18
- package/dist/types/models/LLMTracesListResponse.d.ts +0 -5
- package/dist/types/models/LanguagesView.d.ts +0 -5
- package/dist/types/models/LinkCourseRequest.d.ts +0 -3
- package/dist/types/models/LinkCourseResponse.d.ts +0 -5
- package/dist/types/models/LlmProviderEnum.d.ts +0 -8
- package/dist/types/models/MCPServer.d.ts +0 -47
- package/dist/types/models/MaskedIntegrationCredential.d.ts +0 -10
- package/dist/types/models/MaskedLLMCredential.d.ts +0 -10
- package/dist/types/models/MemoryComponentData.d.ts +0 -5
- package/dist/types/models/MemoryComponentMemory.d.ts +0 -4
- package/dist/types/models/MemoryComponentMemoryDetail.d.ts +0 -8
- package/dist/types/models/MemoryComponentResponse.d.ts +0 -5
- package/dist/types/models/MemoryProgress.d.ts +0 -8
- package/dist/types/models/MemoryStatusRequestView.d.ts +0 -6
- package/dist/types/models/MemoryStatusView.d.ts +0 -6
- package/dist/types/models/Mentor.d.ts +0 -126
- package/dist/types/models/MentorAudience.d.ts +0 -5
- package/dist/types/models/MentorBreakdown.d.ts +0 -9
- package/dist/types/models/MentorCategory.d.ts +0 -9
- package/dist/types/models/MentorCategoryCreate.d.ts +0 -11
- package/dist/types/models/MentorCategoryGroup.d.ts +0 -11
- package/dist/types/models/MentorCategoryGroupCreate.d.ts +0 -11
- package/dist/types/models/MentorCreate.d.ts +0 -116
- package/dist/types/models/MentorCustomVoice.d.ts +0 -4
- package/dist/types/models/MentorCustomVoiceResponse.d.ts +0 -4
- package/dist/types/models/MentorData.d.ts +0 -7
- package/dist/types/models/MentorDetailAnalytics.d.ts +0 -6
- package/dist/types/models/MentorEval.d.ts +0 -11
- package/dist/types/models/MentorEvalQuestion.d.ts +0 -5
- package/dist/types/models/MentorEvalQuestionRequest.d.ts +0 -4
- package/dist/types/models/MentorEvalReport.d.ts +0 -10
- package/dist/types/models/MentorEvalRequest.d.ts +0 -8
- package/dist/types/models/MentorFacet.d.ts +0 -17
- package/dist/types/models/MentorFork.d.ts +0 -5
- package/dist/types/models/MentorFromTemplateWithSettingRequest.d.ts +0 -59
- package/dist/types/models/MentorMemorySettingsRequest.d.ts +0 -6
- package/dist/types/models/MentorMemorySettingsResponse.d.ts +0 -6
- package/dist/types/models/MentorMetadata.d.ts +0 -5
- package/dist/types/models/MentorScenario.d.ts +0 -6
- package/dist/types/models/MentorScenarioPrompt.d.ts +0 -5
- package/dist/types/models/MentorSearchResponse.d.ts +0 -35
- package/dist/types/models/MentorSession.d.ts +0 -4
- package/dist/types/models/MentorSettings.d.ts +0 -94
- package/dist/types/models/MentorSettingsPublic.d.ts +0 -71
- package/dist/types/models/MentorSettingsRequest.d.ts +0 -72
- package/dist/types/models/MentorSummary.d.ts +0 -5
- package/dist/types/models/MentorType.d.ts +0 -5
- package/dist/types/models/MentorUserSetting.d.ts +0 -4
- package/dist/types/models/MentorVisibilityEnum.d.ts +0 -10
- package/dist/types/models/MentorWizard.d.ts +0 -4
- package/dist/types/models/MessageStatistics.d.ts +0 -5
- package/dist/types/models/MessageView.d.ts +0 -10
- package/dist/types/models/MessageViewRequest.d.ts +0 -8
- package/dist/types/models/MessageViewUpdatResponse.d.ts +0 -3
- package/dist/types/models/Metadata.d.ts +0 -5
- package/dist/types/models/MetricChange.d.ts +0 -4
- package/dist/types/models/MetricInfo.d.ts +0 -5
- package/dist/types/models/ModelCost.d.ts +0 -4
- package/dist/types/models/ModerationLog.d.ts +0 -12
- package/dist/types/models/NoChatMessagesFound.d.ts +0 -3
- package/dist/types/models/OAuthStartResponse.d.ts +0 -3
- package/dist/types/models/Observation.d.ts +0 -31
- package/dist/types/models/OvertimeData.d.ts +0 -13
- package/dist/types/models/PageContent.d.ts +0 -6
- package/dist/types/models/PaginatedAIGeneratedImageList.d.ts +0 -7
- package/dist/types/models/PaginatedArtifactListList.d.ts +0 -7
- package/dist/types/models/PaginatedConversationsList.d.ts +0 -7
- package/dist/types/models/PaginatedCourseCreationTaskFileList.d.ts +0 -7
- package/dist/types/models/PaginatedCourseCreationTaskList.d.ts +0 -7
- package/dist/types/models/PaginatedDataSetList.d.ts +0 -7
- package/dist/types/models/PaginatedDisclaimerAgreementList.d.ts +0 -7
- package/dist/types/models/PaginatedDisclaimerList.d.ts +0 -7
- package/dist/types/models/PaginatedEdxCourseList.d.ts +0 -7
- package/dist/types/models/PaginatedEmailPromptListList.d.ts +0 -7
- package/dist/types/models/PaginatedHeygenMarketingVideoListList.d.ts +0 -7
- package/dist/types/models/PaginatedHeygenTemplateResponseSingleList.d.ts +0 -7
- package/dist/types/models/PaginatedHumanSupportTicketList.d.ts +0 -7
- package/dist/types/models/PaginatedJobRunList.d.ts +0 -7
- package/dist/types/models/PaginatedMCPServerList.d.ts +0 -7
- package/dist/types/models/PaginatedMentorList.d.ts +0 -7
- package/dist/types/models/PaginatedModerationLogList.d.ts +0 -7
- package/dist/types/models/PaginatedObservationList.d.ts +0 -7
- package/dist/types/models/PaginatedPeriodicAgentList.d.ts +0 -7
- package/dist/types/models/PaginatedPeriodicAgentLogList.d.ts +0 -7
- package/dist/types/models/PaginatedPlayWrightScriptList.d.ts +0 -7
- package/dist/types/models/PaginatedProjectList.d.ts +0 -7
- package/dist/types/models/PaginatedRetrieverDocumentEmbeddingList.d.ts +0 -7
- package/dist/types/models/PaginatedSectionList.d.ts +0 -7
- package/dist/types/models/PaginatedSubSectionList.d.ts +0 -7
- package/dist/types/models/PaginatedTicketMessageList.d.ts +0 -7
- package/dist/types/models/PaginatedTopicStatisticsResponse.d.ts +0 -7
- package/dist/types/models/PaginatedTraceList.d.ts +0 -7
- package/dist/types/models/PaginatedTrainingList.d.ts +0 -7
- package/dist/types/models/PaginatedUnitList.d.ts +0 -7
- package/dist/types/models/PaginatedUserEdxMemoryList.d.ts +0 -7
- package/dist/types/models/PaginatedUserMemoryList.d.ts +0 -7
- package/dist/types/models/PaginatedVeoVideoListList.d.ts +0 -7
- package/dist/types/models/PaginatedVoiceList.d.ts +0 -7
- package/dist/types/models/PatchedArtifact.d.ts +0 -56
- package/dist/types/models/PatchedBotCommand.d.ts +0 -6
- package/dist/types/models/PatchedBotCreate.d.ts +0 -12
- package/dist/types/models/PatchedCallConfiguration.d.ts +0 -26
- package/dist/types/models/PatchedConversations.d.ts +0 -33
- package/dist/types/models/PatchedCourseCreationTaskFile.d.ts +0 -7
- package/dist/types/models/PatchedCredentialRequest.d.ts +0 -14
- package/dist/types/models/PatchedDataSet.d.ts +0 -21
- package/dist/types/models/PatchedDisclaimer.d.ts +0 -17
- package/dist/types/models/PatchedDiscordConfig.d.ts +0 -7
- package/dist/types/models/PatchedDiscordUserConfig.d.ts +0 -10
- package/dist/types/models/PatchedHumanSupportTicket.d.ts +0 -23
- package/dist/types/models/PatchedLLMCredentialRequest.d.ts +0 -14
- package/dist/types/models/PatchedMCPServer.d.ts +0 -47
- package/dist/types/models/PatchedMentorCategoryGroupCreate.d.ts +0 -11
- package/dist/types/models/PatchedMentorCreate.d.ts +0 -116
- package/dist/types/models/PatchedPeriodicAgentCreate.d.ts +0 -41
- package/dist/types/models/PatchedPlayWrightScript.d.ts +0 -12
- package/dist/types/models/PatchedProject.d.ts +0 -51
- package/dist/types/models/PatchedPrompt.d.ts +0 -22
- package/dist/types/models/PatchedSection.d.ts +0 -9
- package/dist/types/models/PatchedSlackConfig.d.ts +0 -8
- package/dist/types/models/PatchedSlackUserConfig.d.ts +0 -17
- package/dist/types/models/PatchedSubSection.d.ts +0 -9
- package/dist/types/models/PatchedTeamsConfig.d.ts +0 -7
- package/dist/types/models/PatchedTicketMessage.d.ts +0 -10
- package/dist/types/models/PatchedTrainingCreate.d.ts +0 -31
- package/dist/types/models/PatchedUnit.d.ts +0 -11
- package/dist/types/models/PatchedWebexConfig.d.ts +0 -10
- package/dist/types/models/PatchedWhatsappConfig.d.ts +0 -11
- package/dist/types/models/PatchedWhatsappUserConfig.d.ts +0 -10
- package/dist/types/models/PeriodInfo.d.ts +0 -21
- package/dist/types/models/PeriodicAgent.d.ts +0 -42
- package/dist/types/models/PeriodicAgentCreate.d.ts +0 -41
- package/dist/types/models/PeriodicAgentLog.d.ts +0 -11
- package/dist/types/models/PeriodicAgentLogStatusEnum.d.ts +0 -10
- package/dist/types/models/PeriodicAgentStatistics.d.ts +0 -7
- package/dist/types/models/PeriodicTask.d.ts +0 -21
- package/dist/types/models/PieChartData.d.ts +0 -5
- package/dist/types/models/PieChartSegment.d.ts +0 -4
- package/dist/types/models/PinnedMessageCreate.d.ts +0 -9
- package/dist/types/models/PinnedMessageGet.d.ts +0 -7
- package/dist/types/models/PinnedMessageRequest.d.ts +0 -6
- package/dist/types/models/PlatformPrompt.d.ts +0 -34
- package/dist/types/models/PlatformPromptResponse.d.ts +0 -16
- package/dist/types/models/PlayWrightScript.d.ts +0 -12
- package/dist/types/models/PredictiveAnalyticsRequest.d.ts +0 -4
- package/dist/types/models/PredictiveAnalyticsResponse.d.ts +0 -4
- package/dist/types/models/PreviousAgentStatusEnum.d.ts +0 -12
- package/dist/types/models/Project.d.ts +0 -51
- package/dist/types/models/ProjectMentor.d.ts +0 -11
- package/dist/types/models/Prompt.d.ts +0 -22
- package/dist/types/models/PromptCategory.d.ts +0 -7
- package/dist/types/models/PromptFacet.d.ts +0 -17
- package/dist/types/models/PromptSearchResponse.d.ts +0 -35
- package/dist/types/models/PromptVisibilityEnum.d.ts +0 -10
- package/dist/types/models/Provider05cEnum.d.ts +0 -14
- package/dist/types/models/Provider637Enum.d.ts +0 -10
- package/dist/types/models/Provider63aEnum.d.ts +0 -6
- package/dist/types/models/ProviderBreakdown.d.ts +0 -8
- package/dist/types/models/QuestionCardTag.d.ts +0 -8
- package/dist/types/models/QuestionRequest.d.ts +0 -15
- package/dist/types/models/QuestionResponse.d.ts +0 -10
- package/dist/types/models/RatingAverageRecord.d.ts +0 -10
- package/dist/types/models/RatingEnum.d.ts +0 -8
- package/dist/types/models/RatingRecord.d.ts +0 -4
- package/dist/types/models/RatingsOvertime.d.ts +0 -5
- package/dist/types/models/RecentlyAccessedMentor.d.ts +0 -10
- package/dist/types/models/RecommendCourseBlock.d.ts +0 -3
- package/dist/types/models/RecommendCourseResponse.d.ts +0 -3
- package/dist/types/models/RecommendationTypeEnum.d.ts +0 -8
- package/dist/types/models/RecommendedCoursesResponse.d.ts +0 -33
- package/dist/types/models/RelatedText.d.ts +0 -3
- package/dist/types/models/RemoveMentorFromDisclaimer.d.ts +0 -12
- package/dist/types/models/RequestDataVariable.d.ts +0 -14
- package/dist/types/models/ResourceScrappedData.d.ts +0 -13
- package/dist/types/models/ResourceScrappedDataStatusEnum.d.ts +0 -12
- package/dist/types/models/ResponseDataVariable.d.ts +0 -14
- package/dist/types/models/RetreiverTrainViewRequest.d.ts +0 -10
- package/dist/types/models/RetreiverTrainViewResponse.d.ts +0 -6
- package/dist/types/models/RetrieveTask.d.ts +0 -3
- package/dist/types/models/RetrieverDocumentEmbedding.d.ts +0 -30
- package/dist/types/models/RetrieverDocumentEmbeddingRequest.d.ts +0 -66
- package/dist/types/models/RetrieverRequestSearch.d.ts +0 -10
- package/dist/types/models/RetrieverRequestSearchDocument.d.ts +0 -10
- package/dist/types/models/RetrieverResponseSearch.d.ts +0 -7
- package/dist/types/models/ReuestDataVariableList.d.ts +0 -4
- package/dist/types/models/RunMentorEval.d.ts +0 -3
- package/dist/types/models/ScanWebhookRequest.d.ts +0 -6
- package/dist/types/models/ScanWebhookResponse.d.ts +0 -3
- package/dist/types/models/ScopeEnum.d.ts +0 -8
- package/dist/types/models/Section.d.ts +0 -9
- package/dist/types/models/SectionWithChildren.d.ts +0 -11
- package/dist/types/models/SeedMentorsView.d.ts +0 -3
- package/dist/types/models/SentimentSummary.d.ts +0 -4
- package/dist/types/models/ServiceEnum.d.ts +0 -12
- package/dist/types/models/SessionBrowserScreenshot.d.ts +0 -8
- package/dist/types/models/SessionChartPoint.d.ts +0 -4
- package/dist/types/models/SessionDetail.d.ts +0 -6
- package/dist/types/models/SessionMemoryAttachment.d.ts +0 -3
- package/dist/types/models/SessionMemoryStorage.d.ts +0 -6
- package/dist/types/models/SessionsChart.d.ts +0 -5
- package/dist/types/models/ShareableMentorLink.d.ts +0 -8
- package/dist/types/models/ShellLogs.d.ts +0 -3
- package/dist/types/models/SlackConfig.d.ts +0 -8
- package/dist/types/models/SlackUserConfig.d.ts +0 -17
- package/dist/types/models/SlackWebhook.d.ts +0 -6
- package/dist/types/models/SpacedRepetitionLearningPath.d.ts +0 -3
- package/dist/types/models/SpacedRepetitionQuestionStats.d.ts +0 -5
- package/dist/types/models/StarMentor.d.ts +0 -7
- package/dist/types/models/Status6eeEnum.d.ts +0 -12
- package/dist/types/models/Step.d.ts +0 -9
- package/dist/types/models/StepStatusEnum.d.ts +0 -10
- package/dist/types/models/SttProviderEnum.d.ts +0 -12
- package/dist/types/models/StudentChatMessage.d.ts +0 -4
- package/dist/types/models/StylesView.d.ts +0 -4
- package/dist/types/models/SubSection.d.ts +0 -9
- package/dist/types/models/SubSectionWithChildren.d.ts +0 -11
- package/dist/types/models/Subject.d.ts +0 -5
- package/dist/types/models/Summary.d.ts +0 -9
- package/dist/types/models/TagsView.d.ts +0 -5
- package/dist/types/models/TargetSystemEnum.d.ts +0 -8
- package/dist/types/models/TaskView.d.ts +0 -3
- package/dist/types/models/TeamsConfig.d.ts +0 -7
- package/dist/types/models/TeamsWebhook.d.ts +0 -17
- package/dist/types/models/TemplateMentor.d.ts +0 -9
- package/dist/types/models/TenantMentorTraces.d.ts +0 -6
- package/dist/types/models/ThemeEnum.d.ts +0 -8
- package/dist/types/models/TicketMessage.d.ts +0 -10
- package/dist/types/models/TonesView.d.ts +0 -4
- package/dist/types/models/ToolCategory.d.ts +0 -5
- package/dist/types/models/ToolResponse.d.ts +0 -15
- package/dist/types/models/TopicDetail.d.ts +0 -8
- package/dist/types/models/TopicDetails.d.ts +0 -5
- package/dist/types/models/TopicModel.d.ts +0 -3
- package/dist/types/models/TopicRecord.d.ts +0 -4
- package/dist/types/models/TopicStatistics.d.ts +0 -7
- package/dist/types/models/TopicStatisticsResponse.d.ts +0 -6
- package/dist/types/models/TopicSummaryView.d.ts +0 -4
- package/dist/types/models/TopicsOverview.d.ts +0 -22
- package/dist/types/models/TopicsOverviewMetric.d.ts +0 -21
- package/dist/types/models/Trace.d.ts +0 -17
- package/dist/types/models/TrainChatSessionDocumentView.d.ts +0 -6
- package/dist/types/models/TrainChatSessionDocumentViewRequest.d.ts +0 -6
- package/dist/types/models/TrainDocumentViewRequest.d.ts +0 -82
- package/dist/types/models/TrainDocumentViewResponse.d.ts +0 -15
- package/dist/types/models/Training.d.ts +0 -41
- package/dist/types/models/TrainingCreate.d.ts +0 -31
- package/dist/types/models/TrainingStatusEnum.d.ts +0 -12
- package/dist/types/models/TransportEnum.d.ts +0 -10
- package/dist/types/models/TrendEntry.d.ts +0 -4
- package/dist/types/models/TriggerRequest.d.ts +0 -5
- package/dist/types/models/TriggerResponse.d.ts +0 -6
- package/dist/types/models/TtsProviderEnum.d.ts +0 -10
- package/dist/types/models/TypeC42Enum.d.ts +0 -8
- package/dist/types/models/Unit.d.ts +0 -11
- package/dist/types/models/UnitWithChildren.d.ts +0 -13
- package/dist/types/models/UseMainCreds.d.ts +0 -3
- package/dist/types/models/UserAllChatMemoryView.d.ts +0 -7
- package/dist/types/models/UserCatalogItemMemoryView.d.ts +0 -14
- package/dist/types/models/UserChatByPeriod.d.ts +0 -4
- package/dist/types/models/UserChatFeedback.d.ts +0 -15
- package/dist/types/models/UserChatFeedbackCount.d.ts +0 -4
- package/dist/types/models/UserChatMemoryStatusRequestView.d.ts +0 -6
- package/dist/types/models/UserChatMemoryStatusView.d.ts +0 -6
- package/dist/types/models/UserChatMemoryUpdateView.d.ts +0 -10
- package/dist/types/models/UserCountRecord.d.ts +0 -4
- package/dist/types/models/UserDetail.d.ts +0 -7
- package/dist/types/models/UserEdxMemory.d.ts +0 -15
- package/dist/types/models/UserMemory.d.ts +0 -18
- package/dist/types/models/UserMemoryContextRequest.d.ts +0 -13
- package/dist/types/models/UserMemoryContextResponse.d.ts +0 -12
- package/dist/types/models/UserMemoryEntry.d.ts +0 -9
- package/dist/types/models/UserMemoryEntryRequest.d.ts +0 -5
- package/dist/types/models/UserMemoryRequest.d.ts +0 -12
- package/dist/types/models/UserMetric.d.ts +0 -4
- package/dist/types/models/UserMetricsResponse.d.ts +0 -7
- package/dist/types/models/UserSentimentCountView.d.ts +0 -4
- package/dist/types/models/UserTrendByPeriod.d.ts +0 -5
- package/dist/types/models/V2GlobalMentorSearchResponse.d.ts +0 -29
- package/dist/types/models/V2PersonalizedMentorsResponse.d.ts +0 -29
- package/dist/types/models/V2RecommendationResponse.d.ts +0 -65
- package/dist/types/models/VectorResult.d.ts +0 -10
- package/dist/types/models/VeoVideoDetail.d.ts +0 -10
- package/dist/types/models/VeoVideoList.d.ts +0 -6
- package/dist/types/models/VeoVideoRequest.d.ts +0 -5
- package/dist/types/models/VideoCaption.d.ts +0 -3
- package/dist/types/models/Voice.d.ts +0 -9
- package/dist/types/models/WebResource.d.ts +0 -9
- package/dist/types/models/WebResourceCard.d.ts +0 -7
- package/dist/types/models/WebResourcesQuery.d.ts +0 -3
- package/dist/types/models/WebexConfig.d.ts +0 -10
- package/dist/types/models/WebexWebhook.d.ts +0 -4
- package/dist/types/models/WhatAppWebHook.d.ts +0 -3
- package/dist/types/models/WhatsappConfig.d.ts +0 -11
- package/dist/types/models/WhatsappUserConfig.d.ts +0 -10
- package/dist/types/services/AiAccountService.d.ts +0 -519
- package/dist/types/services/AiBotService.d.ts +0 -650
- package/dist/types/services/AiFinetuningService.d.ts +0 -232
- package/dist/types/services/AiIndexService.d.ts +0 -399
- package/dist/types/services/AiMarketingService.d.ts +0 -38
- package/dist/types/services/AiMediaService.d.ts +0 -247
- package/dist/types/services/AiMentorService.d.ts +0 -6616
- package/dist/types/services/AiPromptService.d.ts +0 -1035
- package/dist/types/services/AiSearchService.d.ts +0 -439
- package/src/models/AIGeneratedImage.ts +0 -18
- package/src/models/AIUserProfileMemoryRelation.ts +0 -9
- package/src/models/AIUserProfileRequest.ts +0 -9
- package/src/models/AccessEnum.ts +0 -12
- package/src/models/AccessTimesHeatmap.ts +0 -10
- package/src/models/AccessibleMentorsByEmailRequest.ts +0 -18
- package/src/models/AccessibleMentorsByEmailResponse.ts +0 -18
- package/src/models/ActionBreakdown.ts +0 -15
- package/src/models/AddMentorToDisclaimer.ts +0 -17
- package/src/models/AlignMentorBubbleEnum.ts +0 -12
- package/src/models/AnalyticsOverview.ts +0 -12
- package/src/models/Answer.ts +0 -16
- package/src/models/Artifact.ts +0 -61
- package/src/models/ArtifactList.ts +0 -50
- package/src/models/AssumedKnowledge.ts +0 -9
- package/src/models/AssumedKnowledgeLevel.ts +0 -9
- package/src/models/AudioToTextRequest.ts +0 -8
- package/src/models/AudioToTextResponse.ts +0 -8
- package/src/models/AuthTypeEnum.ts +0 -14
- package/src/models/AutoMemoryPrompt.ts +0 -9
- package/src/models/BaseFinanceResponse.ts +0 -42
- package/src/models/BillingPeriod.ts +0 -13
- package/src/models/Bot.ts +0 -20
- package/src/models/BotCommand.ts +0 -11
- package/src/models/BotCreate.ts +0 -17
- package/src/models/Breakdown.ts +0 -16
- package/src/models/CallAuthenticationRequest.ts +0 -22
- package/src/models/CallAuthenticationResponse.ts +0 -26
- package/src/models/CallConfiguration.ts +0 -31
- package/src/models/CallConfigurationModeEnum.ts +0 -12
- package/src/models/ChatHistory.ts +0 -14
- package/src/models/ChatHistoryFilterData.ts +0 -14
- package/src/models/ChatHistoryFilterUser.ts +0 -10
- package/src/models/ChatHistoryItem.ts +0 -10
- package/src/models/ChatHistorySessionId.ts +0 -8
- package/src/models/ChatSessionRequest.ts +0 -20
- package/src/models/ChatSessionResponse.ts +0 -11
- package/src/models/CheckDocumentTrainingStatus.ts +0 -15
- package/src/models/ComparisonInfo.ts +0 -34
- package/src/models/ComponentBlock.ts +0 -14
- package/src/models/ComponentBlockTypeEnum.ts +0 -12
- package/src/models/ConnectedService.ts +0 -16
- package/src/models/ConnectedServiceProviderEnum.ts +0 -10
- package/src/models/ConversationChartPoint.ts +0 -9
- package/src/models/ConversationDetailResponse.ts +0 -9
- package/src/models/ConversationListItem.ts +0 -29
- package/src/models/ConversationListResponse.ts +0 -11
- package/src/models/ConversationMessage.ts +0 -16
- package/src/models/ConversationRating.ts +0 -11
- package/src/models/ConversationSummary.ts +0 -10
- package/src/models/ConversationVolume.ts +0 -9
- package/src/models/Conversations.ts +0 -38
- package/src/models/ConversationsChart.ts +0 -10
- package/src/models/Cost.ts +0 -8
- package/src/models/CostPerTenant.ts +0 -11
- package/src/models/CourseCreationTask.ts +0 -36
- package/src/models/CourseCreationTaskFile.ts +0 -12
- package/src/models/CourseCreationTaskStatusEnum.ts +0 -20
- package/src/models/CourseRecommendation.ts +0 -50
- package/src/models/CrawlerPatternTypeEnum.ts +0 -12
- package/src/models/CredentialRequest.ts +0 -19
- package/src/models/CrontabSchedule.ts +0 -27
- package/src/models/CurrentUsersResponse.ts +0 -13
- package/src/models/CustomInstructionResponse.ts +0 -18
- package/src/models/DataSet.ts +0 -26
- package/src/models/DataSetCreate.ts +0 -17
- package/src/models/DataSetStatusEnum.ts +0 -16
- package/src/models/DateRange.ts +0 -9
- package/src/models/Disclaimer.ts +0 -22
- package/src/models/DisclaimerAgreement.ts +0 -16
- package/src/models/DiscordConfig.ts +0 -12
- package/src/models/DiscordUserConfig.ts +0 -15
- package/src/models/DiscordWebhook.ts +0 -11
- package/src/models/Document.ts +0 -46
- package/src/models/DocumentFacet.ts +0 -22
- package/src/models/DocumentFromPoolRequest.ts +0 -15
- package/src/models/DocumentSearchResponse.ts +0 -40
- package/src/models/DocumentSettingsResponse.ts +0 -8
- package/src/models/EdxCourse.ts +0 -16
- package/src/models/ElevenlabsCustomVoice.ts +0 -9
- package/src/models/ElevenlabsCustomVoiceResponse.ts +0 -13
- package/src/models/EmailPromptDetail.ts +0 -18
- package/src/models/EmailPromptList.ts +0 -16
- package/src/models/EmailPromptSummary.ts +0 -10
- package/src/models/Entity.ts +0 -16
- package/src/models/EntityTypeEnum.ts +0 -14
- package/src/models/ExternalServiceInfo.ts +0 -11
- package/src/models/FileUploadURLRequest.ts +0 -26
- package/src/models/FileUploadURLResponse.ts +0 -30
- package/src/models/FinanceDetailsResponse.ts +0 -18
- package/src/models/FinanceFilters.ts +0 -20
- package/src/models/FreeUsageCount.ts +0 -8
- package/src/models/FullCourse.ts +0 -18
- package/src/models/GreetingMethodEnum.ts +0 -12
- package/src/models/GuidedPrompt.ts +0 -9
- package/src/models/GuidedPromptsResponse.ts +0 -10
- package/src/models/HeygenMarketingVideoDetail.ts +0 -13
- package/src/models/HeygenMarketingVideoList.ts +0 -11
- package/src/models/HeygenTemplateRequest.ts +0 -10
- package/src/models/HeygenTemplateResponseSingle.ts +0 -11
- package/src/models/HeygenVideoDetail.ts +0 -13
- package/src/models/HeygenVideoRequest.ts +0 -10
- package/src/models/HumanSupportTicket.ts +0 -28
- package/src/models/HumanSupportTicketStatusEnum.ts +0 -14
- package/src/models/InputQuestion.ts +0 -11
- package/src/models/IntegrationCredential.ts +0 -15
- package/src/models/IntegrationCredentialSchema.ts +0 -11
- package/src/models/IntialQuestionAnswer.ts +0 -8
- package/src/models/InvoiceReportResponse.ts +0 -18
- package/src/models/JobRun.ts +0 -16
- package/src/models/KindEnum.ts +0 -14
- package/src/models/LLMCredentialRequest.ts +0 -19
- package/src/models/LLMCredentialResponse.ts +0 -15
- package/src/models/LLMCredentialSchema.ts +0 -11
- package/src/models/LLMModelForTenant.ts +0 -11
- package/src/models/LLMQuestion.ts +0 -20
- package/src/models/LLMResponse.ts +0 -23
- package/src/models/LLMTracesListResponse.ts +0 -10
- package/src/models/LanguagesView.ts +0 -10
- package/src/models/LinkCourseRequest.ts +0 -8
- package/src/models/LinkCourseResponse.ts +0 -10
- package/src/models/LlmProviderEnum.ts +0 -12
- package/src/models/MCPServer.ts +0 -52
- package/src/models/MaskedIntegrationCredential.ts +0 -15
- package/src/models/MaskedLLMCredential.ts +0 -15
- package/src/models/MemoryComponentData.ts +0 -10
- package/src/models/MemoryComponentMemory.ts +0 -9
- package/src/models/MemoryComponentMemoryDetail.ts +0 -13
- package/src/models/MemoryComponentResponse.ts +0 -10
- package/src/models/MemoryProgress.ts +0 -13
- package/src/models/MemoryStatusRequestView.ts +0 -11
- package/src/models/MemoryStatusView.ts +0 -11
- package/src/models/Mentor.ts +0 -131
- package/src/models/MentorAudience.ts +0 -10
- package/src/models/MentorBreakdown.ts +0 -14
- package/src/models/MentorCategory.ts +0 -14
- package/src/models/MentorCategoryCreate.ts +0 -16
- package/src/models/MentorCategoryGroup.ts +0 -16
- package/src/models/MentorCategoryGroupCreate.ts +0 -16
- package/src/models/MentorCreate.ts +0 -121
- package/src/models/MentorCustomVoice.ts +0 -9
- package/src/models/MentorCustomVoiceResponse.ts +0 -9
- package/src/models/MentorData.ts +0 -12
- package/src/models/MentorDetailAnalytics.ts +0 -11
- package/src/models/MentorEval.ts +0 -16
- package/src/models/MentorEvalQuestion.ts +0 -10
- package/src/models/MentorEvalQuestionRequest.ts +0 -9
- package/src/models/MentorEvalReport.ts +0 -15
- package/src/models/MentorEvalRequest.ts +0 -13
- package/src/models/MentorFacet.ts +0 -22
- package/src/models/MentorFork.ts +0 -10
- package/src/models/MentorFromTemplateWithSettingRequest.ts +0 -64
- package/src/models/MentorMemorySettingsRequest.ts +0 -11
- package/src/models/MentorMemorySettingsResponse.ts +0 -11
- package/src/models/MentorMetadata.ts +0 -10
- package/src/models/MentorScenario.ts +0 -11
- package/src/models/MentorScenarioPrompt.ts +0 -10
- package/src/models/MentorSearchResponse.ts +0 -40
- package/src/models/MentorSession.ts +0 -9
- package/src/models/MentorSettings.ts +0 -99
- package/src/models/MentorSettingsPublic.ts +0 -76
- package/src/models/MentorSettingsRequest.ts +0 -77
- package/src/models/MentorSummary.ts +0 -10
- package/src/models/MentorType.ts +0 -10
- package/src/models/MentorUserSetting.ts +0 -9
- package/src/models/MentorVisibilityEnum.ts +0 -14
- package/src/models/MentorWizard.ts +0 -9
- package/src/models/MessageStatistics.ts +0 -10
- package/src/models/MessageView.ts +0 -15
- package/src/models/MessageViewRequest.ts +0 -13
- package/src/models/MessageViewUpdatResponse.ts +0 -8
- package/src/models/Metadata.ts +0 -10
- package/src/models/MetricChange.ts +0 -9
- package/src/models/MetricInfo.ts +0 -10
- package/src/models/ModelCost.ts +0 -9
- package/src/models/ModerationLog.ts +0 -17
- package/src/models/NoChatMessagesFound.ts +0 -8
- package/src/models/OAuthStartResponse.ts +0 -8
- package/src/models/Observation.ts +0 -36
- package/src/models/OvertimeData.ts +0 -18
- package/src/models/PageContent.ts +0 -11
- package/src/models/PaginatedAIGeneratedImageList.ts +0 -12
- package/src/models/PaginatedArtifactListList.ts +0 -12
- package/src/models/PaginatedConversationsList.ts +0 -12
- package/src/models/PaginatedCourseCreationTaskFileList.ts +0 -12
- package/src/models/PaginatedCourseCreationTaskList.ts +0 -12
- package/src/models/PaginatedDataSetList.ts +0 -12
- package/src/models/PaginatedDisclaimerAgreementList.ts +0 -12
- package/src/models/PaginatedDisclaimerList.ts +0 -12
- package/src/models/PaginatedEdxCourseList.ts +0 -12
- package/src/models/PaginatedEmailPromptListList.ts +0 -12
- package/src/models/PaginatedHeygenMarketingVideoListList.ts +0 -12
- package/src/models/PaginatedHeygenTemplateResponseSingleList.ts +0 -12
- package/src/models/PaginatedHumanSupportTicketList.ts +0 -12
- package/src/models/PaginatedJobRunList.ts +0 -12
- package/src/models/PaginatedMCPServerList.ts +0 -12
- package/src/models/PaginatedMentorList.ts +0 -12
- package/src/models/PaginatedModerationLogList.ts +0 -12
- package/src/models/PaginatedObservationList.ts +0 -12
- package/src/models/PaginatedPeriodicAgentList.ts +0 -12
- package/src/models/PaginatedPeriodicAgentLogList.ts +0 -12
- package/src/models/PaginatedPlayWrightScriptList.ts +0 -12
- package/src/models/PaginatedProjectList.ts +0 -12
- package/src/models/PaginatedRetrieverDocumentEmbeddingList.ts +0 -12
- package/src/models/PaginatedSectionList.ts +0 -12
- package/src/models/PaginatedSubSectionList.ts +0 -12
- package/src/models/PaginatedTicketMessageList.ts +0 -12
- package/src/models/PaginatedTopicStatisticsResponse.ts +0 -12
- package/src/models/PaginatedTraceList.ts +0 -12
- package/src/models/PaginatedTrainingList.ts +0 -12
- package/src/models/PaginatedUnitList.ts +0 -12
- package/src/models/PaginatedUserEdxMemoryList.ts +0 -12
- package/src/models/PaginatedUserMemoryList.ts +0 -12
- package/src/models/PaginatedVeoVideoListList.ts +0 -12
- package/src/models/PaginatedVoiceList.ts +0 -12
- package/src/models/PatchedArtifact.ts +0 -61
- package/src/models/PatchedBotCommand.ts +0 -11
- package/src/models/PatchedBotCreate.ts +0 -17
- package/src/models/PatchedCallConfiguration.ts +0 -31
- package/src/models/PatchedConversations.ts +0 -38
- package/src/models/PatchedCourseCreationTaskFile.ts +0 -12
- package/src/models/PatchedCredentialRequest.ts +0 -19
- package/src/models/PatchedDataSet.ts +0 -26
- package/src/models/PatchedDisclaimer.ts +0 -22
- package/src/models/PatchedDiscordConfig.ts +0 -12
- package/src/models/PatchedDiscordUserConfig.ts +0 -15
- package/src/models/PatchedHumanSupportTicket.ts +0 -28
- package/src/models/PatchedLLMCredentialRequest.ts +0 -19
- package/src/models/PatchedMCPServer.ts +0 -52
- package/src/models/PatchedMentorCategoryGroupCreate.ts +0 -16
- package/src/models/PatchedMentorCreate.ts +0 -121
- package/src/models/PatchedPeriodicAgentCreate.ts +0 -46
- package/src/models/PatchedPlayWrightScript.ts +0 -17
- package/src/models/PatchedProject.ts +0 -56
- package/src/models/PatchedPrompt.ts +0 -27
- package/src/models/PatchedSection.ts +0 -14
- package/src/models/PatchedSlackConfig.ts +0 -13
- package/src/models/PatchedSlackUserConfig.ts +0 -22
- package/src/models/PatchedSubSection.ts +0 -14
- package/src/models/PatchedTeamsConfig.ts +0 -12
- package/src/models/PatchedTicketMessage.ts +0 -15
- package/src/models/PatchedTrainingCreate.ts +0 -36
- package/src/models/PatchedUnit.ts +0 -16
- package/src/models/PatchedWebexConfig.ts +0 -15
- package/src/models/PatchedWhatsappConfig.ts +0 -16
- package/src/models/PatchedWhatsappUserConfig.ts +0 -15
- package/src/models/PeriodInfo.ts +0 -26
- package/src/models/PeriodicAgent.ts +0 -47
- package/src/models/PeriodicAgentCreate.ts +0 -46
- package/src/models/PeriodicAgentLog.ts +0 -16
- package/src/models/PeriodicAgentLogStatusEnum.ts +0 -14
- package/src/models/PeriodicAgentStatistics.ts +0 -12
- package/src/models/PeriodicTask.ts +0 -26
- package/src/models/PieChartData.ts +0 -10
- package/src/models/PieChartSegment.ts +0 -9
- package/src/models/PinnedMessageCreate.ts +0 -14
- package/src/models/PinnedMessageGet.ts +0 -12
- package/src/models/PinnedMessageRequest.ts +0 -11
- package/src/models/PlatformPrompt.ts +0 -39
- package/src/models/PlatformPromptResponse.ts +0 -21
- package/src/models/PlayWrightScript.ts +0 -17
- package/src/models/PredictiveAnalyticsRequest.ts +0 -9
- package/src/models/PredictiveAnalyticsResponse.ts +0 -9
- package/src/models/PreviousAgentStatusEnum.ts +0 -16
- package/src/models/Project.ts +0 -56
- package/src/models/ProjectMentor.ts +0 -16
- package/src/models/Prompt.ts +0 -27
- package/src/models/PromptCategory.ts +0 -12
- package/src/models/PromptFacet.ts +0 -22
- package/src/models/PromptSearchResponse.ts +0 -40
- package/src/models/PromptVisibilityEnum.ts +0 -14
- package/src/models/Provider05cEnum.ts +0 -18
- package/src/models/Provider637Enum.ts +0 -14
- package/src/models/Provider63aEnum.ts +0 -10
- package/src/models/ProviderBreakdown.ts +0 -13
- package/src/models/QuestionCardTag.ts +0 -13
- package/src/models/QuestionRequest.ts +0 -20
- package/src/models/QuestionResponse.ts +0 -15
- package/src/models/RatingAverageRecord.ts +0 -15
- package/src/models/RatingEnum.ts +0 -12
- package/src/models/RatingRecord.ts +0 -9
- package/src/models/RatingsOvertime.ts +0 -10
- package/src/models/RecentlyAccessedMentor.ts +0 -15
- package/src/models/RecommendCourseBlock.ts +0 -8
- package/src/models/RecommendCourseResponse.ts +0 -8
- package/src/models/RecommendationTypeEnum.ts +0 -12
- package/src/models/RecommendedCoursesResponse.ts +0 -38
- package/src/models/RelatedText.ts +0 -8
- package/src/models/RemoveMentorFromDisclaimer.ts +0 -17
- package/src/models/RequestDataVariable.ts +0 -19
- package/src/models/ResourceScrappedData.ts +0 -18
- package/src/models/ResourceScrappedDataStatusEnum.ts +0 -16
- package/src/models/ResponseDataVariable.ts +0 -19
- package/src/models/RetreiverTrainViewRequest.ts +0 -15
- package/src/models/RetreiverTrainViewResponse.ts +0 -11
- package/src/models/RetrieveTask.ts +0 -8
- package/src/models/RetrieverDocumentEmbedding.ts +0 -35
- package/src/models/RetrieverDocumentEmbeddingRequest.ts +0 -71
- package/src/models/RetrieverRequestSearch.ts +0 -15
- package/src/models/RetrieverRequestSearchDocument.ts +0 -15
- package/src/models/RetrieverResponseSearch.ts +0 -12
- package/src/models/ReuestDataVariableList.ts +0 -9
- package/src/models/RunMentorEval.ts +0 -8
- package/src/models/ScanWebhookRequest.ts +0 -11
- package/src/models/ScanWebhookResponse.ts +0 -8
- package/src/models/ScopeEnum.ts +0 -12
- package/src/models/Section.ts +0 -14
- package/src/models/SectionWithChildren.ts +0 -16
- package/src/models/SeedMentorsView.ts +0 -8
- package/src/models/SentimentSummary.ts +0 -9
- package/src/models/ServiceEnum.ts +0 -16
- package/src/models/SessionBrowserScreenshot.ts +0 -13
- package/src/models/SessionChartPoint.ts +0 -9
- package/src/models/SessionDetail.ts +0 -11
- package/src/models/SessionMemoryAttachment.ts +0 -8
- package/src/models/SessionMemoryStorage.ts +0 -11
- package/src/models/SessionsChart.ts +0 -10
- package/src/models/ShareableMentorLink.ts +0 -13
- package/src/models/ShellLogs.ts +0 -8
- package/src/models/SlackConfig.ts +0 -13
- package/src/models/SlackUserConfig.ts +0 -22
- package/src/models/SlackWebhook.ts +0 -11
- package/src/models/SpacedRepetitionLearningPath.ts +0 -8
- package/src/models/SpacedRepetitionQuestionStats.ts +0 -10
- package/src/models/StarMentor.ts +0 -12
- package/src/models/Status6eeEnum.ts +0 -16
- package/src/models/Step.ts +0 -14
- package/src/models/StepStatusEnum.ts +0 -14
- package/src/models/SttProviderEnum.ts +0 -16
- package/src/models/StudentChatMessage.ts +0 -9
- package/src/models/StylesView.ts +0 -9
- package/src/models/SubSection.ts +0 -14
- package/src/models/SubSectionWithChildren.ts +0 -16
- package/src/models/Subject.ts +0 -10
- package/src/models/Summary.ts +0 -14
- package/src/models/TagsView.ts +0 -10
- package/src/models/TargetSystemEnum.ts +0 -12
- package/src/models/TaskView.ts +0 -8
- package/src/models/TeamsConfig.ts +0 -12
- package/src/models/TeamsWebhook.ts +0 -22
- package/src/models/TemplateMentor.ts +0 -14
- package/src/models/TenantMentorTraces.ts +0 -11
- package/src/models/ThemeEnum.ts +0 -12
- package/src/models/TicketMessage.ts +0 -15
- package/src/models/TonesView.ts +0 -9
- package/src/models/ToolCategory.ts +0 -10
- package/src/models/ToolResponse.ts +0 -20
- package/src/models/TopicDetail.ts +0 -13
- package/src/models/TopicDetails.ts +0 -10
- package/src/models/TopicModel.ts +0 -8
- package/src/models/TopicRecord.ts +0 -9
- package/src/models/TopicStatistics.ts +0 -12
- package/src/models/TopicStatisticsResponse.ts +0 -11
- package/src/models/TopicSummaryView.ts +0 -9
- package/src/models/TopicsOverview.ts +0 -27
- package/src/models/TopicsOverviewMetric.ts +0 -26
- package/src/models/Trace.ts +0 -22
- package/src/models/TrainChatSessionDocumentView.ts +0 -11
- package/src/models/TrainChatSessionDocumentViewRequest.ts +0 -11
- package/src/models/TrainDocumentViewRequest.ts +0 -87
- package/src/models/TrainDocumentViewResponse.ts +0 -20
- package/src/models/Training.ts +0 -46
- package/src/models/TrainingCreate.ts +0 -36
- package/src/models/TrainingStatusEnum.ts +0 -16
- package/src/models/TransportEnum.ts +0 -14
- package/src/models/TrendEntry.ts +0 -9
- package/src/models/TriggerRequest.ts +0 -10
- package/src/models/TriggerResponse.ts +0 -11
- package/src/models/TtsProviderEnum.ts +0 -14
- package/src/models/TypeC42Enum.ts +0 -12
- package/src/models/Unit.ts +0 -16
- package/src/models/UnitWithChildren.ts +0 -18
- package/src/models/UseMainCreds.ts +0 -8
- package/src/models/UserAllChatMemoryView.ts +0 -12
- package/src/models/UserCatalogItemMemoryView.ts +0 -19
- package/src/models/UserChatByPeriod.ts +0 -9
- package/src/models/UserChatFeedback.ts +0 -20
- package/src/models/UserChatFeedbackCount.ts +0 -9
- package/src/models/UserChatMemoryStatusRequestView.ts +0 -11
- package/src/models/UserChatMemoryStatusView.ts +0 -11
- package/src/models/UserChatMemoryUpdateView.ts +0 -15
- package/src/models/UserCountRecord.ts +0 -9
- package/src/models/UserDetail.ts +0 -12
- package/src/models/UserEdxMemory.ts +0 -20
- package/src/models/UserMemory.ts +0 -23
- package/src/models/UserMemoryContextRequest.ts +0 -18
- package/src/models/UserMemoryContextResponse.ts +0 -17
- package/src/models/UserMemoryEntry.ts +0 -14
- package/src/models/UserMemoryEntryRequest.ts +0 -10
- package/src/models/UserMemoryRequest.ts +0 -17
- package/src/models/UserMetric.ts +0 -9
- package/src/models/UserMetricsResponse.ts +0 -12
- package/src/models/UserSentimentCountView.ts +0 -9
- package/src/models/UserTrendByPeriod.ts +0 -10
- package/src/models/V2GlobalMentorSearchResponse.ts +0 -34
- package/src/models/V2PersonalizedMentorsResponse.ts +0 -34
- package/src/models/V2RecommendationResponse.ts +0 -70
- package/src/models/VectorResult.ts +0 -15
- package/src/models/VeoVideoDetail.ts +0 -15
- package/src/models/VeoVideoList.ts +0 -11
- package/src/models/VeoVideoRequest.ts +0 -10
- package/src/models/VideoCaption.ts +0 -8
- package/src/models/Voice.ts +0 -14
- package/src/models/WebResource.ts +0 -14
- package/src/models/WebResourceCard.ts +0 -12
- package/src/models/WebResourcesQuery.ts +0 -8
- package/src/models/WebexConfig.ts +0 -15
- package/src/models/WebexWebhook.ts +0 -9
- package/src/models/WhatAppWebHook.ts +0 -8
- package/src/models/WhatsappConfig.ts +0 -16
- package/src/models/WhatsappUserConfig.ts +0 -15
- package/src/services/AiAccountService.ts +0 -858
- package/src/services/AiBotService.ts +0 -1350
- package/src/services/AiFinetuningService.ts +0 -472
- package/src/services/AiIndexService.ts +0 -710
- package/src/services/AiMarketingService.ts +0 -96
- package/src/services/AiMediaService.ts +0 -532
- package/src/services/AiMentorService.ts +0 -12140
- package/src/services/AiPromptService.ts +0 -1985
- package/src/services/AiSearchService.ts +0 -728
|
@@ -2,22 +2,10 @@
|
|
|
2
2
|
/* istanbul ignore file */
|
|
3
3
|
/* tslint:disable */
|
|
4
4
|
/* eslint-disable */
|
|
5
|
-
import type { AccessTimesHeatmap } from '../models/AccessTimesHeatmap';
|
|
6
|
-
import type { BaseFinanceResponse } from '../models/BaseFinanceResponse';
|
|
7
5
|
import type { ContentDetailsResponse } from '../models/ContentDetailsResponse';
|
|
8
6
|
import type { ContentResponse } from '../models/ContentResponse';
|
|
9
|
-
import type { ConversationDetailResponse } from '../models/ConversationDetailResponse';
|
|
10
|
-
import type { ConversationListResponse } from '../models/ConversationListResponse';
|
|
11
|
-
import type { CurrentUsersResponse } from '../models/CurrentUsersResponse';
|
|
12
|
-
import type { FinanceDetailsResponse } from '../models/FinanceDetailsResponse';
|
|
13
|
-
import type { InvoiceReportResponse } from '../models/InvoiceReportResponse';
|
|
14
7
|
import type { LearnerAnalyticsResponse } from '../models/LearnerAnalyticsResponse';
|
|
15
8
|
import type { LearnerListResponse } from '../models/LearnerListResponse';
|
|
16
|
-
import type { RatingsOvertime } from '../models/RatingsOvertime';
|
|
17
|
-
import type { SessionsChart } from '../models/SessionsChart';
|
|
18
|
-
import type { TopicDetails } from '../models/TopicDetails';
|
|
19
|
-
import type { TopicsOverview } from '../models/TopicsOverview';
|
|
20
|
-
import type { UserDetail } from '../models/UserDetail';
|
|
21
9
|
import type { CancelablePromise } from '../core/CancelablePromise';
|
|
22
10
|
import { OpenAPI } from '../core/OpenAPI';
|
|
23
11
|
import { request as __request } from '../core/request';
|
|
@@ -61,7 +49,6 @@ export class AnalyticsService {
|
|
|
61
49
|
granularity = 'hour',
|
|
62
50
|
includeOvertime = false,
|
|
63
51
|
limit = 20,
|
|
64
|
-
mentorUniqueId,
|
|
65
52
|
page = 1,
|
|
66
53
|
platformKey,
|
|
67
54
|
startDate,
|
|
@@ -104,7 +91,6 @@ export class AnalyticsService {
|
|
|
104
91
|
* Number of items per page (max 100)
|
|
105
92
|
*/
|
|
106
93
|
limit?: number,
|
|
107
|
-
mentorUniqueId?: string,
|
|
108
94
|
/**
|
|
109
95
|
* Page number for pagination
|
|
110
96
|
*/
|
|
@@ -124,7 +110,6 @@ export class AnalyticsService {
|
|
|
124
110
|
'granularity': granularity,
|
|
125
111
|
'include_overtime': includeOvertime,
|
|
126
112
|
'limit': limit,
|
|
127
|
-
'mentor_unique_id': mentorUniqueId,
|
|
128
113
|
'metric': metric,
|
|
129
114
|
'page': page,
|
|
130
115
|
'platform_key': platformKey,
|
|
@@ -144,7 +129,6 @@ export class AnalyticsService {
|
|
|
144
129
|
dateFilter = 'today',
|
|
145
130
|
endDate,
|
|
146
131
|
limit = 10,
|
|
147
|
-
mentorUniqueId,
|
|
148
132
|
page = 1,
|
|
149
133
|
platformKey,
|
|
150
134
|
search,
|
|
@@ -179,7 +163,6 @@ export class AnalyticsService {
|
|
|
179
163
|
* Number of learner records per page
|
|
180
164
|
*/
|
|
181
165
|
limit?: number,
|
|
182
|
-
mentorUniqueId?: string,
|
|
183
166
|
page?: number,
|
|
184
167
|
platformKey?: string,
|
|
185
168
|
search?: string,
|
|
@@ -199,7 +182,6 @@ export class AnalyticsService {
|
|
|
199
182
|
'date_filter': dateFilter,
|
|
200
183
|
'end_date': endDate,
|
|
201
184
|
'limit': limit,
|
|
202
|
-
'mentor_unique_id': mentorUniqueId,
|
|
203
185
|
'metric': metric,
|
|
204
186
|
'page': page,
|
|
205
187
|
'platform_key': platformKey,
|
|
@@ -210,1224 +192,185 @@ export class AnalyticsService {
|
|
|
210
192
|
});
|
|
211
193
|
}
|
|
212
194
|
/**
|
|
213
|
-
*
|
|
195
|
+
* Unified API endpoint for learner analytics.
|
|
214
196
|
*
|
|
215
|
-
* This endpoint provides
|
|
216
|
-
* -
|
|
217
|
-
*
|
|
218
|
-
* - Percentage change vs comparison periods
|
|
219
|
-
* - Forward-filled time series
|
|
197
|
+
* This endpoint provides either:
|
|
198
|
+
* 1. Cross-platform summary (when only username is provided)
|
|
199
|
+
* 2. Platform-specific detailed data (when username + platform_key are provided)
|
|
220
200
|
*
|
|
221
|
-
*
|
|
201
|
+
* Query params:
|
|
202
|
+
* - username (required): Username of the learner
|
|
203
|
+
* - platform_key (optional): Platform key for platform-specific data
|
|
204
|
+
* - page (optional): Page number (default: 1)
|
|
205
|
+
* - limit (optional): Records per page (default: 20, max: 100)
|
|
222
206
|
*
|
|
223
|
-
*
|
|
224
|
-
*
|
|
225
|
-
*
|
|
226
|
-
*
|
|
227
|
-
*
|
|
228
|
-
|
|
229
|
-
|
|
230
|
-
|
|
231
|
-
|
|
232
|
-
|
|
233
|
-
|
|
234
|
-
|
|
235
|
-
|
|
236
|
-
|
|
237
|
-
|
|
238
|
-
|
|
239
|
-
|
|
240
|
-
|
|
241
|
-
|
|
242
|
-
|
|
207
|
+
* Returns:
|
|
208
|
+
* - If platform_key provided: Detailed platform metrics
|
|
209
|
+
* - If no platform_key: Cross-platform summary with pagination
|
|
210
|
+
* @returns LearnerAnalyticsResponse
|
|
211
|
+
* @throws ApiError
|
|
212
|
+
*/
|
|
213
|
+
public static analyticsLearnersRetrieve({
|
|
214
|
+
dateFilter = 'today',
|
|
215
|
+
endDate,
|
|
216
|
+
granularity = 'hour',
|
|
217
|
+
limit = 20,
|
|
218
|
+
overtime = false,
|
|
219
|
+
page = 1,
|
|
220
|
+
platformKey,
|
|
221
|
+
startDate,
|
|
222
|
+
username,
|
|
223
|
+
}: {
|
|
224
|
+
/**
|
|
225
|
+
* * `today` - Today only
|
|
226
|
+
* * `7d` - Last 7 days
|
|
227
|
+
* * `30d` - Last 30 days
|
|
228
|
+
* * `90d` - Last 90 days
|
|
229
|
+
* * `all_time` - All time
|
|
230
|
+
* * `custom` - Custom date range
|
|
231
|
+
*/
|
|
232
|
+
dateFilter?: 'today' | '7d' | '30d' | '90d' | 'all_time' | 'custom',
|
|
233
|
+
endDate?: string,
|
|
234
|
+
/**
|
|
235
|
+
* * `day` - day
|
|
236
|
+
* * `hour` - hour
|
|
237
|
+
* * `week` - week
|
|
238
|
+
* * `month` - month
|
|
239
|
+
*/
|
|
240
|
+
granularity?: 'day' | 'hour' | 'week' | 'month',
|
|
241
|
+
/**
|
|
242
|
+
* Number of records per page (default: 20, max: 100)
|
|
243
|
+
*/
|
|
244
|
+
limit?: number,
|
|
245
|
+
/**
|
|
246
|
+
* Include overtime metrics for the user in the platform (default: false)
|
|
247
|
+
*/
|
|
248
|
+
overtime?: boolean,
|
|
249
|
+
/**
|
|
250
|
+
* Page number (default: 1)
|
|
251
|
+
*/
|
|
252
|
+
page?: number,
|
|
253
|
+
/**
|
|
254
|
+
* Optional platform key - if provided, returns platform-specific detailed data
|
|
255
|
+
*/
|
|
256
|
+
platformKey?: string,
|
|
257
|
+
startDate?: string,
|
|
258
|
+
/**
|
|
259
|
+
* Username of the learner to get analytics for. Defaults to self if not provided.
|
|
260
|
+
*/
|
|
261
|
+
username?: string,
|
|
262
|
+
}): CancelablePromise<LearnerAnalyticsResponse> {
|
|
263
|
+
return __request(OpenAPI, {
|
|
264
|
+
method: 'GET',
|
|
265
|
+
url: '/api/analytics/learners/',
|
|
266
|
+
query: {
|
|
267
|
+
'date_filter': dateFilter,
|
|
268
|
+
'end_date': endDate,
|
|
269
|
+
'granularity': granularity,
|
|
270
|
+
'limit': limit,
|
|
271
|
+
'overtime': overtime,
|
|
272
|
+
'page': page,
|
|
273
|
+
'platform_key': platformKey,
|
|
274
|
+
'start_date': startDate,
|
|
275
|
+
'username': username,
|
|
276
|
+
},
|
|
277
|
+
});
|
|
278
|
+
}
|
|
279
|
+
/**
|
|
243
280
|
*
|
|
281
|
+
* Retrieve a paginated list of learners for a specific platform with their comprehensive
|
|
282
|
+
* metrics from the UserPlatformSummary materialized view. This endpoint is accessible only
|
|
283
|
+
* to platform administrators and supports search, sorting, and pagination.
|
|
244
284
|
*
|
|
245
|
-
*
|
|
246
|
-
*
|
|
247
|
-
|
|
248
|
-
|
|
249
|
-
|
|
250
|
-
|
|
251
|
-
|
|
252
|
-
|
|
253
|
-
|
|
254
|
-
|
|
255
|
-
|
|
256
|
-
|
|
257
|
-
|
|
258
|
-
|
|
259
|
-
|
|
260
|
-
|
|
261
|
-
|
|
262
|
-
|
|
263
|
-
|
|
264
|
-
|
|
265
|
-
|
|
266
|
-
|
|
267
|
-
|
|
268
|
-
|
|
269
|
-
|
|
270
|
-
|
|
271
|
-
|
|
272
|
-
|
|
273
|
-
|
|
274
|
-
|
|
275
|
-
|
|
276
|
-
|
|
277
|
-
|
|
278
|
-
|
|
279
|
-
|
|
280
|
-
|
|
281
|
-
|
|
282
|
-
|
|
283
|
-
|
|
284
|
-
|
|
285
|
-
|
|
286
|
-
|
|
287
|
-
|
|
288
|
-
|
|
289
|
-
|
|
290
|
-
|
|
291
|
-
|
|
292
|
-
|
|
293
|
-
|
|
294
|
-
|
|
295
|
-
|
|
296
|
-
|
|
297
|
-
|
|
298
|
-
|
|
299
|
-
|
|
300
|
-
|
|
301
|
-
|
|
302
|
-
|
|
303
|
-
|
|
304
|
-
|
|
305
|
-
|
|
306
|
-
|
|
307
|
-
|
|
308
|
-
|
|
309
|
-
|
|
310
|
-
|
|
311
|
-
|
|
312
|
-
|
|
313
|
-
|
|
314
|
-
|
|
315
|
-
|
|
316
|
-
|
|
317
|
-
|
|
318
|
-
|
|
319
|
-
|
|
320
|
-
|
|
321
|
-
|
|
322
|
-
|
|
323
|
-
|
|
324
|
-
|
|
325
|
-
|
|
326
|
-
|
|
327
|
-
|
|
328
|
-
|
|
329
|
-
|
|
330
|
-
|
|
331
|
-
|
|
332
|
-
|
|
333
|
-
|
|
334
|
-
|
|
335
|
-
|
|
336
|
-
|
|
337
|
-
provider?: 'openai' | 'anthropic' | 'azure' | 'google' | 'meta' | 'other',
|
|
338
|
-
/**
|
|
339
|
-
* Whether to include overtime series data in response
|
|
340
|
-
*/
|
|
341
|
-
showOvertime?: boolean,
|
|
342
|
-
startDate?: string,
|
|
343
|
-
/**
|
|
344
|
-
* Filter by specific username - returns costs for this user only
|
|
345
|
-
*/
|
|
346
|
-
username?: string,
|
|
347
|
-
}): CancelablePromise<BaseFinanceResponse> {
|
|
348
|
-
return __request(OpenAPI, {
|
|
349
|
-
method: 'GET',
|
|
350
|
-
url: '/api/analytics/financial/',
|
|
351
|
-
query: {
|
|
352
|
-
'comparison_days': comparisonDays,
|
|
353
|
-
'date_filter': dateFilter,
|
|
354
|
-
'end_date': endDate,
|
|
355
|
-
'fill_method': fillMethod,
|
|
356
|
-
'granularity': granularity,
|
|
357
|
-
'llm_model': llmModel,
|
|
358
|
-
'mentor_unique_id': mentorUniqueId,
|
|
359
|
-
'metric': metric,
|
|
360
|
-
'platform_key': platformKey,
|
|
361
|
-
'provider': provider,
|
|
362
|
-
'show_overtime': showOvertime,
|
|
363
|
-
'start_date': startDate,
|
|
364
|
-
'username': username,
|
|
365
|
-
},
|
|
366
|
-
errors: {
|
|
367
|
-
400: `Bad Request - Invalid query parameters`,
|
|
368
|
-
403: `Forbidden - Insufficient permissions`,
|
|
369
|
-
500: `Internal Server Error`,
|
|
370
|
-
},
|
|
371
|
-
});
|
|
372
|
-
}
|
|
373
|
-
/**
|
|
374
|
-
* Financial Details Analytics API – paginated cost tables with flexible grouping.
|
|
375
|
-
*
|
|
376
|
-
* This endpoint returns tabular cost metrics aggregated by the dimension
|
|
377
|
-
* specified via the `group_by` query parameter. One or more KPI columns
|
|
378
|
-
* can be requested through the comma-separated `metrics` list while
|
|
379
|
-
* typical filters (date range, provider, platform_key, user, etc.) narrow the
|
|
380
|
-
* dataset. Results are paginated with `page` / `limit`.
|
|
381
|
-
*
|
|
382
|
-
* **Required query parameters**
|
|
383
|
-
* - group_by – provider | llm_model | username | mentor | platform
|
|
384
|
-
* - metrics – csv list of KPI names, e.g. total_cost, sessions
|
|
385
|
-
*
|
|
386
|
-
* **Shared optional filters**
|
|
387
|
-
* - start_date, end_date – ISO yyyy-mm-dd (ignored when all_time=true)
|
|
388
|
-
* - platform_key – tenant isolation
|
|
389
|
-
* - mentor_unique_id – filter to one mentor
|
|
390
|
-
* - username – filter to a learner
|
|
391
|
-
* - provider / llm_model – filter to LLM provider / model
|
|
392
|
-
* - all_time – true → lifetime totals
|
|
393
|
-
* - page (default 1), limit (default 50)
|
|
394
|
-
*
|
|
395
|
-
* **Examples**
|
|
396
|
-
* --------
|
|
397
|
-
* 1. Cost by provider for the last week
|
|
398
|
-
* ```
|
|
399
|
-
* GET /api/v2/analytics/financial/details?
|
|
400
|
-
* group_by=provider&
|
|
401
|
-
* metrics=total_cost&
|
|
402
|
-
* start_date=2025-01-01&
|
|
403
|
-
* end_date=2025-01-07&
|
|
404
|
-
* page=1&limit=10
|
|
405
|
-
* ```
|
|
406
|
-
*
|
|
407
|
-
* 2. Lifetime cost per user with extra KPIs
|
|
408
|
-
* ```
|
|
409
|
-
* GET /api/v2/analytics/financial/details?
|
|
410
|
-
* group_by=username&
|
|
411
|
-
* metrics=total_cost,sessions&
|
|
412
|
-
* all_time=true&page=1&limit=50
|
|
413
|
-
* ```
|
|
414
|
-
* 3. Cost by LLM model with tenant filter
|
|
415
|
-
* ```
|
|
416
|
-
* GET /api/v2/analytics/financial/details?
|
|
417
|
-
* group_by=llm_model&
|
|
418
|
-
* metrics=total_cost&
|
|
419
|
-
* platform_key=web-app&
|
|
420
|
-
* start_date=2025-01-01&end_date=2025-01-31
|
|
421
|
-
* ```
|
|
422
|
-
* Response structure
|
|
423
|
-
* -------------------
|
|
424
|
-
* ```
|
|
425
|
-
* {
|
|
426
|
-
* "page": 1,
|
|
427
|
-
* "limit": 10,
|
|
428
|
-
* "total_pages": 1,
|
|
429
|
-
* "total_records": 3,
|
|
430
|
-
* "rows": [
|
|
431
|
-
* {"provider": "openai", "total_cost": "2.50000"},
|
|
432
|
-
* {"provider": "anthropic", "total_cost": "1.00000"},
|
|
433
|
-
* {"provider": "azure", "total_cost": "0.50000"}
|
|
434
|
-
* ],
|
|
435
|
-
* "metrics": [
|
|
436
|
-
* {
|
|
437
|
-
* "name": "total_cost",
|
|
438
|
-
* "unit": "$",
|
|
439
|
-
* "description": "Cost for this entity in period"
|
|
440
|
-
* }
|
|
441
|
-
* ],
|
|
442
|
-
* "total_cost": "4.00000" // optional grand-total when available
|
|
443
|
-
* }
|
|
444
|
-
* ``
|
|
445
|
-
* @returns FinanceDetailsResponse
|
|
446
|
-
* @throws ApiError
|
|
447
|
-
*/
|
|
448
|
-
public static analyticsFinancialDetailsRetrieve({
|
|
449
|
-
groupBy,
|
|
450
|
-
dateFilter = 'today',
|
|
451
|
-
endDate,
|
|
452
|
-
limit = 20,
|
|
453
|
-
llmModel,
|
|
454
|
-
mentorUniqueId,
|
|
455
|
-
metrics = 'total_cost',
|
|
456
|
-
page = 1,
|
|
457
|
-
platformKey,
|
|
458
|
-
provider,
|
|
459
|
-
search,
|
|
460
|
-
startDate,
|
|
461
|
-
username,
|
|
462
|
-
}: {
|
|
463
|
-
/**
|
|
464
|
-
* Dimension to group by
|
|
465
|
-
*
|
|
466
|
-
* * `provider` - Group by provider
|
|
467
|
-
* * `llm_model` - Group by LLM model
|
|
468
|
-
* * `username` - Group by username
|
|
469
|
-
* * `mentor` - Group by mentor
|
|
470
|
-
* * `platform` - Group by platform
|
|
471
|
-
* * `action` - Group by actions
|
|
472
|
-
*/
|
|
473
|
-
groupBy: 'provider' | 'llm_model' | 'username' | 'mentor' | 'platform' | 'action',
|
|
474
|
-
/**
|
|
475
|
-
* * `today` - Today only
|
|
476
|
-
* * `7d` - Last 7 days
|
|
477
|
-
* * `30d` - Last 30 days
|
|
478
|
-
* * `90d` - Last 90 days
|
|
479
|
-
* * `all_time` - All time
|
|
480
|
-
* * `custom` - Custom date range
|
|
481
|
-
*/
|
|
482
|
-
dateFilter?: 'today' | '7d' | '30d' | '90d' | 'all_time' | 'custom',
|
|
483
|
-
endDate?: string,
|
|
484
|
-
limit?: number,
|
|
485
|
-
llmModel?: string,
|
|
486
|
-
mentorUniqueId?: string,
|
|
487
|
-
/**
|
|
488
|
-
* Comma-separated list of metrics (e.g. total_cost,sessions, last_active)
|
|
489
|
-
*/
|
|
490
|
-
metrics?: string,
|
|
491
|
-
page?: number,
|
|
492
|
-
platformKey?: string,
|
|
493
|
-
provider?: string,
|
|
494
|
-
search?: string,
|
|
495
|
-
startDate?: string,
|
|
496
|
-
username?: string,
|
|
497
|
-
}): CancelablePromise<FinanceDetailsResponse> {
|
|
498
|
-
return __request(OpenAPI, {
|
|
499
|
-
method: 'GET',
|
|
500
|
-
url: '/api/analytics/financial/details/',
|
|
501
|
-
query: {
|
|
502
|
-
'date_filter': dateFilter,
|
|
503
|
-
'end_date': endDate,
|
|
504
|
-
'group_by': groupBy,
|
|
505
|
-
'limit': limit,
|
|
506
|
-
'llm_model': llmModel,
|
|
507
|
-
'mentor_unique_id': mentorUniqueId,
|
|
508
|
-
'metrics': metrics,
|
|
509
|
-
'page': page,
|
|
510
|
-
'platform_key': platformKey,
|
|
511
|
-
'provider': provider,
|
|
512
|
-
'search': search,
|
|
513
|
-
'start_date': startDate,
|
|
514
|
-
'username': username,
|
|
515
|
-
},
|
|
516
|
-
errors: {
|
|
517
|
-
400: `Bad Request – invalid query params`,
|
|
518
|
-
500: `Internal Server Error`,
|
|
519
|
-
},
|
|
520
|
-
});
|
|
521
|
-
}
|
|
522
|
-
/**
|
|
523
|
-
* Flexible Invoice Report API – Billing summary with username and platform filtering.
|
|
524
|
-
*
|
|
525
|
-
* This endpoint generates invoice reports with flexible filtering options:
|
|
526
|
-
* - Platform admins can view their platform's data and filter by username within their platform
|
|
527
|
-
* - Super admins can view any combination of username/platform or global summaries
|
|
528
|
-
*
|
|
529
|
-
* **Key Features:**
|
|
530
|
-
* - Flexible filtering by username and/or platform_key
|
|
531
|
-
* - Essential metrics: total cost, sessions, usage period
|
|
532
|
-
* - Provider breakdown (OpenAI, Anthropic, etc.)
|
|
533
|
-
* - Top mentors/actions by cost
|
|
534
|
-
* - Clean, invoice-ready format
|
|
535
|
-
*
|
|
536
|
-
* **Query Parameters:**
|
|
537
|
-
* - username: Filter by specific username (optional)
|
|
538
|
-
* - platform_key: Filter by platform (optional, but required for platform admins)
|
|
539
|
-
* - start_date, end_date: billing period (defaults to last 30 days)
|
|
540
|
-
* - include_breakdown: show provider/mentor details (default: true)
|
|
541
|
-
*
|
|
542
|
-
* **Permission Logic:**
|
|
543
|
-
* - Platform admins: Must include platform_key matching their permission scope
|
|
544
|
-
* - Super admins: Can use any combination of filters or none (global summary)
|
|
545
|
-
*
|
|
546
|
-
* **Examples:**
|
|
547
|
-
* ```
|
|
548
|
-
* # Platform admin viewing their platform
|
|
549
|
-
* GET /api/analytics/financial/invoice?platform_key=web-app
|
|
550
|
-
*
|
|
551
|
-
* # Platform admin viewing specific user in their platform
|
|
552
|
-
* GET /api/analytics/financial/invoice?platform_key=web-app&username=john.doe
|
|
553
|
-
*
|
|
554
|
-
* # Super admin viewing specific user across all platforms
|
|
555
|
-
* GET /api/analytics/financial/invoice?username=john.doe
|
|
556
|
-
*
|
|
557
|
-
* # Super admin viewing global summary
|
|
558
|
-
* GET /api/analytics/financial/invoice
|
|
559
|
-
* ```
|
|
560
|
-
*
|
|
561
|
-
* **Response Structure:**
|
|
562
|
-
* ```json
|
|
563
|
-
* {
|
|
564
|
-
* "entity": {
|
|
565
|
-
* "type": "user|platform|global",
|
|
566
|
-
* "username": "john.doe",
|
|
567
|
-
* "platform_key": "web-app",
|
|
568
|
-
* "platform_name": "Web Application",
|
|
569
|
-
* "display_name": "John Doe on Web Application"
|
|
570
|
-
* },
|
|
571
|
-
* "billing_period": {
|
|
572
|
-
* "start_date": "2025-01-01",
|
|
573
|
-
* "end_date": "2025-01-31",
|
|
574
|
-
* "days": 31
|
|
575
|
-
* },
|
|
576
|
-
* "summary": {
|
|
577
|
-
* "total_cost": 245.750,
|
|
578
|
-
* "total_sessions": 1250,
|
|
579
|
-
* "active_users": 85,
|
|
580
|
-
* "cost_per_session": 0.196
|
|
581
|
-
* },
|
|
582
|
-
* "breakdown": {
|
|
583
|
-
* "by_provider": [...],
|
|
584
|
-
* "by_mentor": [...],
|
|
585
|
-
* "by_action": [...]
|
|
586
|
-
* }
|
|
587
|
-
* }
|
|
588
|
-
* ```
|
|
589
|
-
* @returns InvoiceReportResponse
|
|
590
|
-
* @throws ApiError
|
|
591
|
-
*/
|
|
592
|
-
public static analyticsFinancialInvoiceRetrieve({
|
|
593
|
-
endDate,
|
|
594
|
-
includeBreakdown = true,
|
|
595
|
-
platformKey,
|
|
596
|
-
startDate,
|
|
597
|
-
username,
|
|
598
|
-
}: {
|
|
599
|
-
/**
|
|
600
|
-
* End date for billing period (defaults to today)
|
|
601
|
-
*/
|
|
602
|
-
endDate?: string,
|
|
603
|
-
/**
|
|
604
|
-
* Whether to include provider and mentor breakdown
|
|
605
|
-
*/
|
|
606
|
-
includeBreakdown?: boolean,
|
|
607
|
-
/**
|
|
608
|
-
* Platform key to filter by (optional, required for platform admins)
|
|
609
|
-
*/
|
|
610
|
-
platformKey?: string,
|
|
611
|
-
/**
|
|
612
|
-
* Start date for billing period (defaults to 30 days ago)
|
|
613
|
-
*/
|
|
614
|
-
startDate?: string,
|
|
615
|
-
/**
|
|
616
|
-
* Username to generate invoice for (optional)
|
|
617
|
-
*/
|
|
618
|
-
username?: string,
|
|
619
|
-
}): CancelablePromise<InvoiceReportResponse> {
|
|
620
|
-
return __request(OpenAPI, {
|
|
621
|
-
method: 'GET',
|
|
622
|
-
url: '/api/analytics/financial/invoice/',
|
|
623
|
-
query: {
|
|
624
|
-
'end_date': endDate,
|
|
625
|
-
'include_breakdown': includeBreakdown,
|
|
626
|
-
'platform_key': platformKey,
|
|
627
|
-
'start_date': startDate,
|
|
628
|
-
'username': username,
|
|
629
|
-
},
|
|
630
|
-
errors: {
|
|
631
|
-
400: `Bad Request – invalid parameters`,
|
|
632
|
-
403: `Forbidden – insufficient permissions`,
|
|
633
|
-
404: `No data found`,
|
|
634
|
-
500: `Internal Server Error`,
|
|
635
|
-
},
|
|
636
|
-
});
|
|
637
|
-
}
|
|
638
|
-
/**
|
|
639
|
-
* Unified API endpoint for learner analytics.
|
|
640
|
-
*
|
|
641
|
-
* This endpoint provides either:
|
|
642
|
-
* 1. Cross-platform summary (when only username is provided)
|
|
643
|
-
* 2. Platform-specific detailed data (when username + platform_key are provided)
|
|
644
|
-
*
|
|
645
|
-
* Query params:
|
|
646
|
-
* - username (required): Username of the learner
|
|
647
|
-
* - platform_key (optional): Platform key for platform-specific data
|
|
648
|
-
* - page (optional): Page number (default: 1)
|
|
649
|
-
* - limit (optional): Records per page (default: 20, max: 100)
|
|
650
|
-
*
|
|
651
|
-
* Returns:
|
|
652
|
-
* - If platform_key provided: Detailed platform metrics
|
|
653
|
-
* - If no platform_key: Cross-platform summary with pagination
|
|
654
|
-
* @returns LearnerAnalyticsResponse
|
|
655
|
-
* @throws ApiError
|
|
656
|
-
*/
|
|
657
|
-
public static analyticsLearnersRetrieve({
|
|
658
|
-
dateFilter = 'today',
|
|
659
|
-
endDate,
|
|
660
|
-
granularity = 'hour',
|
|
661
|
-
limit = 20,
|
|
662
|
-
mentorUniqueId,
|
|
663
|
-
overtime = false,
|
|
664
|
-
page = 1,
|
|
665
|
-
platformKey,
|
|
666
|
-
startDate,
|
|
667
|
-
username,
|
|
668
|
-
}: {
|
|
669
|
-
/**
|
|
670
|
-
* * `today` - Today only
|
|
671
|
-
* * `7d` - Last 7 days
|
|
672
|
-
* * `30d` - Last 30 days
|
|
673
|
-
* * `90d` - Last 90 days
|
|
674
|
-
* * `all_time` - All time
|
|
675
|
-
* * `custom` - Custom date range
|
|
676
|
-
*/
|
|
677
|
-
dateFilter?: 'today' | '7d' | '30d' | '90d' | 'all_time' | 'custom',
|
|
678
|
-
endDate?: string,
|
|
679
|
-
/**
|
|
680
|
-
* * `day` - day
|
|
681
|
-
* * `hour` - hour
|
|
682
|
-
* * `week` - week
|
|
683
|
-
* * `month` - month
|
|
684
|
-
*/
|
|
685
|
-
granularity?: 'day' | 'hour' | 'week' | 'month',
|
|
686
|
-
/**
|
|
687
|
-
* Number of records per page (default: 20, max: 100)
|
|
688
|
-
*/
|
|
689
|
-
limit?: number,
|
|
690
|
-
mentorUniqueId?: string,
|
|
691
|
-
/**
|
|
692
|
-
* Include overtime metrics for the user in the platform (default: false)
|
|
693
|
-
*/
|
|
694
|
-
overtime?: boolean,
|
|
695
|
-
/**
|
|
696
|
-
* Page number (default: 1)
|
|
697
|
-
*/
|
|
698
|
-
page?: number,
|
|
699
|
-
/**
|
|
700
|
-
* Optional platform key - if provided, returns platform-specific detailed data
|
|
701
|
-
*/
|
|
702
|
-
platformKey?: string,
|
|
703
|
-
startDate?: string,
|
|
704
|
-
/**
|
|
705
|
-
* Username of the learner to get analytics for. Defaults to self if not provided.
|
|
706
|
-
*/
|
|
707
|
-
username?: string,
|
|
708
|
-
}): CancelablePromise<LearnerAnalyticsResponse> {
|
|
709
|
-
return __request(OpenAPI, {
|
|
710
|
-
method: 'GET',
|
|
711
|
-
url: '/api/analytics/learners/',
|
|
712
|
-
query: {
|
|
713
|
-
'date_filter': dateFilter,
|
|
714
|
-
'end_date': endDate,
|
|
715
|
-
'granularity': granularity,
|
|
716
|
-
'limit': limit,
|
|
717
|
-
'mentor_unique_id': mentorUniqueId,
|
|
718
|
-
'overtime': overtime,
|
|
719
|
-
'page': page,
|
|
720
|
-
'platform_key': platformKey,
|
|
721
|
-
'start_date': startDate,
|
|
722
|
-
'username': username,
|
|
723
|
-
},
|
|
724
|
-
});
|
|
725
|
-
}
|
|
726
|
-
/**
|
|
727
|
-
*
|
|
728
|
-
* Retrieve a paginated list of learners for a specific platform with their comprehensive
|
|
729
|
-
* metrics from the UserPlatformSummary materialized view. This endpoint is accessible only
|
|
730
|
-
* to platform administrators and supports search, sorting, and pagination.
|
|
731
|
-
*
|
|
732
|
-
* @returns LearnerListResponse Paginated list of learners with their metrics
|
|
733
|
-
* @throws ApiError
|
|
734
|
-
*/
|
|
735
|
-
public static analyticsLearnersListRetrieve({
|
|
736
|
-
platformKey,
|
|
737
|
-
dateFilter = 'today',
|
|
738
|
-
endDate,
|
|
739
|
-
granularity = 'hour',
|
|
740
|
-
limit = 20,
|
|
741
|
-
mentorUniqueId,
|
|
742
|
-
page = 1,
|
|
743
|
-
search,
|
|
744
|
-
sortBy = 'last_activity',
|
|
745
|
-
sortOrder = 'desc',
|
|
746
|
-
startDate,
|
|
747
|
-
}: {
|
|
748
|
-
/**
|
|
749
|
-
* Platform key to filter learners by platform
|
|
750
|
-
*/
|
|
751
|
-
platformKey: string,
|
|
752
|
-
/**
|
|
753
|
-
* * `today` - Today only
|
|
754
|
-
* * `7d` - Last 7 days
|
|
755
|
-
* * `30d` - Last 30 days
|
|
756
|
-
* * `90d` - Last 90 days
|
|
757
|
-
* * `all_time` - All time
|
|
758
|
-
* * `custom` - Custom date range
|
|
759
|
-
*/
|
|
760
|
-
dateFilter?: 'today' | '7d' | '30d' | '90d' | 'all_time' | 'custom',
|
|
761
|
-
endDate?: string,
|
|
762
|
-
/**
|
|
763
|
-
* * `day` - day
|
|
764
|
-
* * `hour` - hour
|
|
765
|
-
* * `week` - week
|
|
766
|
-
* * `month` - month
|
|
767
|
-
*/
|
|
768
|
-
granularity?: 'day' | 'hour' | 'week' | 'month',
|
|
769
|
-
/**
|
|
770
|
-
* Number of learners per page (default: 20, max: 100)
|
|
771
|
-
*/
|
|
772
|
-
limit?: number,
|
|
773
|
-
mentorUniqueId?: string,
|
|
774
|
-
/**
|
|
775
|
-
* Page number for pagination (default: 1)
|
|
776
|
-
*/
|
|
777
|
-
page?: number,
|
|
778
|
-
/**
|
|
779
|
-
* Search term to filter learners by username, email, or name
|
|
780
|
-
*/
|
|
781
|
-
search?: string,
|
|
782
|
-
/**
|
|
783
|
-
* Field to sort learners by (default: last_activity)
|
|
784
|
-
*
|
|
785
|
-
* * `username` - Username
|
|
786
|
-
* * `name` - Name
|
|
787
|
-
* * `last_activity` - Last Activity
|
|
788
|
-
* * `total_points` - Total Points
|
|
789
|
-
* * `total_time_spent_seconds` - Time Spent
|
|
790
|
-
* * `total_enrollments` - Enrollments
|
|
791
|
-
* * `total_skills_count` - Skills Count
|
|
792
|
-
*/
|
|
793
|
-
sortBy?: 'username' | 'name' | 'last_activity' | 'total_points' | 'total_time_spent_seconds' | 'total_enrollments' | 'total_skills_count',
|
|
794
|
-
/**
|
|
795
|
-
* Sort order (default: desc)
|
|
796
|
-
*
|
|
797
|
-
* * `asc` - Ascending
|
|
798
|
-
* * `desc` - Descending
|
|
799
|
-
*/
|
|
800
|
-
sortOrder?: 'asc' | 'desc',
|
|
801
|
-
startDate?: string,
|
|
802
|
-
}): CancelablePromise<LearnerListResponse> {
|
|
803
|
-
return __request(OpenAPI, {
|
|
804
|
-
method: 'GET',
|
|
805
|
-
url: '/api/analytics/learners/list/',
|
|
806
|
-
query: {
|
|
807
|
-
'date_filter': dateFilter,
|
|
808
|
-
'end_date': endDate,
|
|
809
|
-
'granularity': granularity,
|
|
810
|
-
'limit': limit,
|
|
811
|
-
'mentor_unique_id': mentorUniqueId,
|
|
812
|
-
'page': page,
|
|
813
|
-
'platform_key': platformKey,
|
|
814
|
-
'search': search,
|
|
815
|
-
'sort_by': sortBy,
|
|
816
|
-
'sort_order': sortOrder,
|
|
817
|
-
'start_date': startDate,
|
|
818
|
-
},
|
|
819
|
-
errors: {
|
|
820
|
-
400: `Bad Request - Invalid parameters supplied`,
|
|
821
|
-
403: `Forbidden - Platform admin access required`,
|
|
822
|
-
500: `Unexpected error`,
|
|
823
|
-
},
|
|
824
|
-
});
|
|
825
|
-
}
|
|
826
|
-
/**
|
|
827
|
-
* Conversation list endpoint for analytics.
|
|
828
|
-
*
|
|
829
|
-
* Query params (all optional unless specified by permissions):
|
|
830
|
-
* - platform_key: filter by platform
|
|
831
|
-
* - mentor_unique_id: filter by mentor
|
|
832
|
-
* - page: page number (default 1)
|
|
833
|
-
* - limit: page size (default 20, max 100)
|
|
834
|
-
* - search: search in user name and first user message
|
|
835
|
-
* - min_messages, max_messages: message_count range
|
|
836
|
-
* - sentiment: positive|negative|neutral
|
|
837
|
-
* - topic: topic name contains
|
|
838
|
-
* - start_date, end_date: date filter on conversation date
|
|
839
|
-
*
|
|
840
|
-
* Returns: summary totals, results list (paginated), and pagination metadata.
|
|
841
|
-
* @returns ConversationListResponse
|
|
842
|
-
* @throws ApiError
|
|
843
|
-
*/
|
|
844
|
-
public static analyticsMessagesRetrieve({
|
|
845
|
-
endDate,
|
|
846
|
-
limit = 20,
|
|
847
|
-
maxMessages,
|
|
848
|
-
mentorUniqueId,
|
|
849
|
-
minMessages,
|
|
850
|
-
page = 1,
|
|
851
|
-
platformKey,
|
|
852
|
-
search,
|
|
853
|
-
sentiment,
|
|
854
|
-
startDate,
|
|
855
|
-
topic,
|
|
856
|
-
}: {
|
|
857
|
-
endDate?: string,
|
|
858
|
-
limit?: number,
|
|
859
|
-
maxMessages?: number,
|
|
860
|
-
mentorUniqueId?: string,
|
|
861
|
-
minMessages?: number,
|
|
862
|
-
page?: number,
|
|
863
|
-
platformKey?: string,
|
|
864
|
-
search?: string,
|
|
865
|
-
/**
|
|
866
|
-
* * `positive` - positive
|
|
867
|
-
* * `negative` - negative
|
|
868
|
-
* * `neutral` - neutral
|
|
869
|
-
*/
|
|
870
|
-
sentiment?: 'positive' | 'negative' | 'neutral',
|
|
871
|
-
startDate?: string,
|
|
872
|
-
topic?: string,
|
|
873
|
-
}): CancelablePromise<ConversationListResponse> {
|
|
874
|
-
return __request(OpenAPI, {
|
|
875
|
-
method: 'GET',
|
|
876
|
-
url: '/api/analytics/messages/',
|
|
877
|
-
query: {
|
|
878
|
-
'end_date': endDate,
|
|
879
|
-
'limit': limit,
|
|
880
|
-
'max_messages': maxMessages,
|
|
881
|
-
'mentor_unique_id': mentorUniqueId,
|
|
882
|
-
'min_messages': minMessages,
|
|
883
|
-
'page': page,
|
|
884
|
-
'platform_key': platformKey,
|
|
885
|
-
'search': search,
|
|
886
|
-
'sentiment': sentiment,
|
|
887
|
-
'start_date': startDate,
|
|
888
|
-
'topic': topic,
|
|
889
|
-
},
|
|
890
|
-
});
|
|
891
|
-
}
|
|
892
|
-
/**
|
|
893
|
-
* Conversation detail endpoint for analytics.
|
|
894
|
-
*
|
|
895
|
-
* Query params:
|
|
896
|
-
* - session_id (required): UUID of the session to fetch
|
|
897
|
-
* - platform_key, mentor_unique_id (optional): further scope
|
|
898
|
-
* - start_date, end_date (optional): date filter on message timestamps
|
|
899
|
-
*
|
|
900
|
-
* Returns: summary metadata from conversation_list MV, and a list of
|
|
901
|
-
* human/ai message pairs in chronological order.
|
|
902
|
-
* @returns ConversationDetailResponse
|
|
903
|
-
* @throws ApiError
|
|
904
|
-
*/
|
|
905
|
-
public static analyticsMessagesDetailsRetrieve({
|
|
906
|
-
sessionId,
|
|
907
|
-
endDate,
|
|
908
|
-
mentorUniqueId,
|
|
909
|
-
platformKey,
|
|
910
|
-
startDate,
|
|
911
|
-
}: {
|
|
912
|
-
sessionId: string,
|
|
913
|
-
endDate?: string,
|
|
914
|
-
mentorUniqueId?: string,
|
|
915
|
-
platformKey?: string,
|
|
916
|
-
startDate?: string,
|
|
917
|
-
}): CancelablePromise<ConversationDetailResponse> {
|
|
918
|
-
return __request(OpenAPI, {
|
|
919
|
-
method: 'GET',
|
|
920
|
-
url: '/api/analytics/messages/details/',
|
|
921
|
-
query: {
|
|
922
|
-
'end_date': endDate,
|
|
923
|
-
'mentor_unique_id': mentorUniqueId,
|
|
924
|
-
'platform_key': platformKey,
|
|
925
|
-
'session_id': sessionId,
|
|
926
|
-
'start_date': startDate,
|
|
927
|
-
},
|
|
928
|
-
});
|
|
929
|
-
}
|
|
930
|
-
/**
|
|
931
|
-
* Ratings overtime endpoint.
|
|
932
|
-
*
|
|
933
|
-
* Query params:
|
|
934
|
-
* - metric: only 'ratings' is supported (default)
|
|
935
|
-
* - platform_key, mentor_unique_id: optional filters
|
|
936
|
-
* - granularity: 'day' (default) or 'hour' (hour only for today)
|
|
937
|
-
* - start_date, end_date: optional date range; defaults applied if not provided
|
|
938
|
-
*
|
|
939
|
-
* Returns: { metric: 'ratings', points: [{date, value}, ...] }
|
|
940
|
-
* @returns RatingsOvertime
|
|
941
|
-
* @throws ApiError
|
|
942
|
-
*/
|
|
943
|
-
public static analyticsRatingsRetrieve({
|
|
944
|
-
dateFilter = 'today',
|
|
945
|
-
endDate,
|
|
946
|
-
granularity = 'hour',
|
|
947
|
-
mentorUniqueId,
|
|
948
|
-
metric = 'ratings',
|
|
949
|
-
platformKey,
|
|
950
|
-
startDate,
|
|
951
|
-
}: {
|
|
952
|
-
/**
|
|
953
|
-
* * `today` - Today only
|
|
954
|
-
* * `7d` - Last 7 days
|
|
955
|
-
* * `30d` - Last 30 days
|
|
956
|
-
* * `90d` - Last 90 days
|
|
957
|
-
* * `all_time` - All time
|
|
958
|
-
* * `custom` - Custom date range
|
|
959
|
-
*/
|
|
960
|
-
dateFilter?: 'today' | '7d' | '30d' | '90d' | 'all_time' | 'custom',
|
|
961
|
-
endDate?: string,
|
|
962
|
-
/**
|
|
963
|
-
* * `day` - day
|
|
964
|
-
* * `hour` - hour
|
|
965
|
-
* * `week` - week
|
|
966
|
-
* * `month` - month
|
|
967
|
-
*/
|
|
968
|
-
granularity?: 'day' | 'hour' | 'week' | 'month',
|
|
969
|
-
mentorUniqueId?: string,
|
|
970
|
-
/**
|
|
971
|
-
* * `ratings` - Ratings over time
|
|
972
|
-
*/
|
|
973
|
-
metric?: 'ratings',
|
|
974
|
-
platformKey?: string,
|
|
975
|
-
startDate?: string,
|
|
976
|
-
}): CancelablePromise<RatingsOvertime> {
|
|
977
|
-
return __request(OpenAPI, {
|
|
978
|
-
method: 'GET',
|
|
979
|
-
url: '/api/analytics/ratings/',
|
|
980
|
-
query: {
|
|
981
|
-
'date_filter': dateFilter,
|
|
982
|
-
'end_date': endDate,
|
|
983
|
-
'granularity': granularity,
|
|
984
|
-
'mentor_unique_id': mentorUniqueId,
|
|
985
|
-
'metric': metric,
|
|
986
|
-
'platform_key': platformKey,
|
|
987
|
-
'start_date': startDate,
|
|
988
|
-
},
|
|
989
|
-
});
|
|
990
|
-
}
|
|
991
|
-
/**
|
|
992
|
-
* @returns SessionsChart
|
|
993
|
-
* @throws ApiError
|
|
994
|
-
*/
|
|
995
|
-
public static analyticsSessionsRetrieve({
|
|
996
|
-
dateFilter = 'today',
|
|
997
|
-
endDate,
|
|
998
|
-
granularity = 'hour',
|
|
999
|
-
mentorUniqueId,
|
|
1000
|
-
metric = 'sessions',
|
|
1001
|
-
platformKey,
|
|
1002
|
-
startDate,
|
|
1003
|
-
}: {
|
|
1004
|
-
/**
|
|
1005
|
-
* * `today` - Today only
|
|
1006
|
-
* * `7d` - Last 7 days
|
|
1007
|
-
* * `30d` - Last 30 days
|
|
1008
|
-
* * `90d` - Last 90 days
|
|
1009
|
-
* * `all_time` - All time
|
|
1010
|
-
* * `custom` - Custom date range
|
|
1011
|
-
*/
|
|
1012
|
-
dateFilter?: 'today' | '7d' | '30d' | '90d' | 'all_time' | 'custom',
|
|
1013
|
-
endDate?: string,
|
|
1014
|
-
/**
|
|
1015
|
-
* * `day` - day
|
|
1016
|
-
* * `hour` - hour
|
|
1017
|
-
* * `week` - week
|
|
1018
|
-
* * `month` - month
|
|
1019
|
-
*/
|
|
1020
|
-
granularity?: 'day' | 'hour' | 'week' | 'month',
|
|
1021
|
-
mentorUniqueId?: string,
|
|
1022
|
-
/**
|
|
1023
|
-
* * `sessions` - Sessions over time
|
|
1024
|
-
* * `headline` - Headline metrics for sessions (avg messages per session, avg rating)
|
|
1025
|
-
*/
|
|
1026
|
-
metric?: 'sessions' | 'headline',
|
|
1027
|
-
platformKey?: string,
|
|
1028
|
-
startDate?: string,
|
|
1029
|
-
}): CancelablePromise<SessionsChart> {
|
|
1030
|
-
return __request(OpenAPI, {
|
|
1031
|
-
method: 'GET',
|
|
1032
|
-
url: '/api/analytics/sessions/',
|
|
1033
|
-
query: {
|
|
1034
|
-
'date_filter': dateFilter,
|
|
1035
|
-
'end_date': endDate,
|
|
1036
|
-
'granularity': granularity,
|
|
1037
|
-
'mentor_unique_id': mentorUniqueId,
|
|
1038
|
-
'metric': metric,
|
|
1039
|
-
'platform_key': platformKey,
|
|
1040
|
-
'start_date': startDate,
|
|
1041
|
-
},
|
|
1042
|
-
});
|
|
1043
|
-
}
|
|
1044
|
-
/**
|
|
1045
|
-
* @returns TopicDetails
|
|
1046
|
-
* @throws ApiError
|
|
1047
|
-
*/
|
|
1048
|
-
public static analyticsSessionsDetailsRetrieve({
|
|
1049
|
-
dateFilter = 'today',
|
|
1050
|
-
endDate,
|
|
1051
|
-
limit = 20,
|
|
1052
|
-
mentorUniqueId,
|
|
1053
|
-
page = 1,
|
|
1054
|
-
platformKey,
|
|
1055
|
-
search,
|
|
1056
|
-
startDate,
|
|
1057
|
-
}: {
|
|
1058
|
-
/**
|
|
1059
|
-
* * `today` - Today only
|
|
1060
|
-
* * `7d` - Last 7 days
|
|
1061
|
-
* * `30d` - Last 30 days
|
|
1062
|
-
* * `90d` - Last 90 days
|
|
1063
|
-
* * `all_time` - All time
|
|
1064
|
-
* * `custom` - Custom date range
|
|
1065
|
-
*/
|
|
1066
|
-
dateFilter?: 'today' | '7d' | '30d' | '90d' | 'all_time' | 'custom',
|
|
1067
|
-
endDate?: string,
|
|
1068
|
-
limit?: number,
|
|
1069
|
-
mentorUniqueId?: string,
|
|
1070
|
-
page?: number,
|
|
1071
|
-
platformKey?: string,
|
|
1072
|
-
/**
|
|
1073
|
-
* Search by topic name
|
|
1074
|
-
*/
|
|
1075
|
-
search?: string,
|
|
1076
|
-
startDate?: string,
|
|
1077
|
-
}): CancelablePromise<TopicDetails> {
|
|
1078
|
-
return __request(OpenAPI, {
|
|
1079
|
-
method: 'GET',
|
|
1080
|
-
url: '/api/analytics/sessions/details/',
|
|
1081
|
-
query: {
|
|
1082
|
-
'date_filter': dateFilter,
|
|
1083
|
-
'end_date': endDate,
|
|
1084
|
-
'limit': limit,
|
|
1085
|
-
'mentor_unique_id': mentorUniqueId,
|
|
1086
|
-
'page': page,
|
|
1087
|
-
'platform_key': platformKey,
|
|
1088
|
-
'search': search,
|
|
1089
|
-
'start_date': startDate,
|
|
1090
|
-
},
|
|
1091
|
-
});
|
|
1092
|
-
}
|
|
1093
|
-
/**
|
|
1094
|
-
*
|
|
1095
|
-
* Time Analytics API - User activity patterns by time of day and day of week.
|
|
1096
|
-
*
|
|
1097
|
-
* Provides heatmap data showing when users are most active, useful for:
|
|
1098
|
-
* - Understanding peak usage times
|
|
1099
|
-
* - Capacity planning and resource allocation
|
|
1100
|
-
* - User behavior analysis
|
|
1101
|
-
* - Support scheduling optimization
|
|
1102
|
-
*
|
|
1103
|
-
* **Key Features:**
|
|
1104
|
-
* - Day of week patterns (0=Sunday through 6=Saturday)
|
|
1105
|
-
* - Hour of day activity levels (0-23)
|
|
1106
|
-
* - Flexible date range filtering
|
|
1107
|
-
* - Platform and mentor-specific filtering
|
|
1108
|
-
* - Message count aggregation
|
|
1109
|
-
*
|
|
1110
|
-
* **Data Structure:**
|
|
1111
|
-
* - `day_of_week`: 0-6 (Sunday-Saturday)
|
|
1112
|
-
* - `hour`: 0-23 (24-hour format)
|
|
1113
|
-
* - `value`: Message count for that time slot
|
|
1114
|
-
*
|
|
1115
|
-
* @returns AccessTimesHeatmap Access times heatmap data with day/hour patterns
|
|
1116
|
-
* @throws ApiError
|
|
1117
|
-
*/
|
|
1118
|
-
public static analyticsTimeRetrieve({
|
|
1119
|
-
dateFilter = 'today',
|
|
1120
|
-
endDate,
|
|
1121
|
-
granularity = 'hour',
|
|
1122
|
-
mentorUniqueId,
|
|
1123
|
-
platformKey,
|
|
1124
|
-
startDate,
|
|
1125
|
-
}: {
|
|
1126
|
-
/**
|
|
1127
|
-
* * `today` - Today only
|
|
1128
|
-
* * `7d` - Last 7 days
|
|
1129
|
-
* * `30d` - Last 30 days
|
|
1130
|
-
* * `90d` - Last 90 days
|
|
1131
|
-
* * `all_time` - All time
|
|
1132
|
-
* * `custom` - Custom date range
|
|
1133
|
-
*/
|
|
1134
|
-
dateFilter?: 'today' | '7d' | '30d' | '90d' | 'all_time' | 'custom',
|
|
1135
|
-
endDate?: string,
|
|
1136
|
-
/**
|
|
1137
|
-
* * `day` - day
|
|
1138
|
-
* * `hour` - hour
|
|
1139
|
-
* * `week` - week
|
|
1140
|
-
* * `month` - month
|
|
1141
|
-
*/
|
|
1142
|
-
granularity?: 'day' | 'hour' | 'week' | 'month',
|
|
1143
|
-
mentorUniqueId?: string,
|
|
1144
|
-
platformKey?: string,
|
|
1145
|
-
startDate?: string,
|
|
1146
|
-
}): CancelablePromise<AccessTimesHeatmap> {
|
|
1147
|
-
return __request(OpenAPI, {
|
|
1148
|
-
method: 'GET',
|
|
1149
|
-
url: '/api/analytics/time/',
|
|
1150
|
-
query: {
|
|
1151
|
-
'date_filter': dateFilter,
|
|
1152
|
-
'end_date': endDate,
|
|
1153
|
-
'granularity': granularity,
|
|
1154
|
-
'mentor_unique_id': mentorUniqueId,
|
|
1155
|
-
'platform_key': platformKey,
|
|
1156
|
-
'start_date': startDate,
|
|
1157
|
-
},
|
|
1158
|
-
errors: {
|
|
1159
|
-
400: `Bad Request - Invalid parameters`,
|
|
1160
|
-
403: `Forbidden - Insufficient permissions`,
|
|
1161
|
-
500: `Internal Server Error`,
|
|
1162
|
-
},
|
|
1163
|
-
});
|
|
1164
|
-
}
|
|
1165
|
-
/**
|
|
1166
|
-
* @returns TopicsOverview
|
|
1167
|
-
* @throws ApiError
|
|
1168
|
-
*/
|
|
1169
|
-
public static analyticsTopicsRetrieve({
|
|
1170
|
-
dateFilter = 'today',
|
|
1171
|
-
endDate,
|
|
1172
|
-
granularity = 'hour',
|
|
1173
|
-
mentorUniqueId,
|
|
1174
|
-
metric = 'overview',
|
|
1175
|
-
platformKey,
|
|
1176
|
-
startDate,
|
|
1177
|
-
}: {
|
|
1178
|
-
/**
|
|
1179
|
-
* * `today` - Today only
|
|
1180
|
-
* * `7d` - Last 7 days
|
|
1181
|
-
* * `30d` - Last 30 days
|
|
1182
|
-
* * `90d` - Last 90 days
|
|
1183
|
-
* * `all_time` - All time
|
|
1184
|
-
* * `custom` - Custom date range
|
|
1185
|
-
*/
|
|
1186
|
-
dateFilter?: 'today' | '7d' | '30d' | '90d' | 'all_time' | 'custom',
|
|
1187
|
-
endDate?: string,
|
|
1188
|
-
/**
|
|
1189
|
-
* * `day` - day
|
|
1190
|
-
* * `hour` - hour
|
|
1191
|
-
* * `week` - week
|
|
1192
|
-
* * `month` - month
|
|
1193
|
-
*/
|
|
1194
|
-
granularity?: 'day' | 'hour' | 'week' | 'month',
|
|
1195
|
-
mentorUniqueId?: string,
|
|
1196
|
-
/**
|
|
1197
|
-
* * `overview` - Overall topic metrics
|
|
1198
|
-
* * `sessions` - Sessions over time
|
|
1199
|
-
* * `ratings` - Ratings over time
|
|
1200
|
-
* * `highlighted` - Highlighted topics
|
|
1201
|
-
*/
|
|
1202
|
-
metric?: 'overview' | 'sessions' | 'ratings' | 'highlighted',
|
|
1203
|
-
platformKey?: string,
|
|
1204
|
-
startDate?: string,
|
|
1205
|
-
}): CancelablePromise<TopicsOverview> {
|
|
1206
|
-
return __request(OpenAPI, {
|
|
1207
|
-
method: 'GET',
|
|
1208
|
-
url: '/api/analytics/topics/',
|
|
1209
|
-
query: {
|
|
1210
|
-
'date_filter': dateFilter,
|
|
1211
|
-
'end_date': endDate,
|
|
1212
|
-
'granularity': granularity,
|
|
1213
|
-
'mentor_unique_id': mentorUniqueId,
|
|
1214
|
-
'metric': metric,
|
|
1215
|
-
'platform_key': platformKey,
|
|
1216
|
-
'start_date': startDate,
|
|
1217
|
-
},
|
|
1218
|
-
});
|
|
1219
|
-
}
|
|
1220
|
-
/**
|
|
1221
|
-
* @returns TopicDetails
|
|
1222
|
-
* @throws ApiError
|
|
1223
|
-
*/
|
|
1224
|
-
public static analyticsTopicsDetailsRetrieve({
|
|
1225
|
-
dateFilter = 'today',
|
|
1226
|
-
endDate,
|
|
1227
|
-
limit = 20,
|
|
1228
|
-
mentorUniqueId,
|
|
1229
|
-
page = 1,
|
|
1230
|
-
platformKey,
|
|
1231
|
-
search,
|
|
1232
|
-
startDate,
|
|
1233
|
-
}: {
|
|
1234
|
-
/**
|
|
1235
|
-
* * `today` - Today only
|
|
1236
|
-
* * `7d` - Last 7 days
|
|
1237
|
-
* * `30d` - Last 30 days
|
|
1238
|
-
* * `90d` - Last 90 days
|
|
1239
|
-
* * `all_time` - All time
|
|
1240
|
-
* * `custom` - Custom date range
|
|
1241
|
-
*/
|
|
1242
|
-
dateFilter?: 'today' | '7d' | '30d' | '90d' | 'all_time' | 'custom',
|
|
1243
|
-
endDate?: string,
|
|
1244
|
-
limit?: number,
|
|
1245
|
-
mentorUniqueId?: string,
|
|
1246
|
-
page?: number,
|
|
1247
|
-
platformKey?: string,
|
|
1248
|
-
/**
|
|
1249
|
-
* Search by topic name
|
|
1250
|
-
*/
|
|
1251
|
-
search?: string,
|
|
1252
|
-
startDate?: string,
|
|
1253
|
-
}): CancelablePromise<TopicDetails> {
|
|
1254
|
-
return __request(OpenAPI, {
|
|
1255
|
-
method: 'GET',
|
|
1256
|
-
url: '/api/analytics/topics/details/',
|
|
1257
|
-
query: {
|
|
1258
|
-
'date_filter': dateFilter,
|
|
1259
|
-
'end_date': endDate,
|
|
1260
|
-
'limit': limit,
|
|
1261
|
-
'mentor_unique_id': mentorUniqueId,
|
|
1262
|
-
'page': page,
|
|
1263
|
-
'platform_key': platformKey,
|
|
1264
|
-
'search': search,
|
|
1265
|
-
'start_date': startDate,
|
|
1266
|
-
},
|
|
1267
|
-
});
|
|
1268
|
-
}
|
|
1269
|
-
/**
|
|
1270
|
-
*
|
|
1271
|
-
* User Analytics API - Comprehensive user activity metrics and trends.
|
|
1272
|
-
*
|
|
1273
|
-
* Provides real-time and historical user analytics including:
|
|
1274
|
-
* - Currently active users (last hour)
|
|
1275
|
-
* - Active users over time periods (7d, 30d, 90d)
|
|
1276
|
-
* - Registered user counts and growth
|
|
1277
|
-
* - Time series charts with customizable granularity
|
|
1278
|
-
*
|
|
1279
|
-
* **Key Features:**
|
|
1280
|
-
* - Real-time active user counting
|
|
1281
|
-
* - Percentage change calculations vs previous periods
|
|
1282
|
-
* - Flexible date filtering and granularity
|
|
1283
|
-
* - Platform and mentor-specific filtering
|
|
1284
|
-
* - Forward-filled time series data
|
|
1285
|
-
*
|
|
1286
|
-
* **Supported Metrics:**
|
|
1287
|
-
* - `currently_active`: Users active in last hour
|
|
1288
|
-
* - `active_users`: Unique users in specified period
|
|
1289
|
-
* - `registered_users`: Total and new user counts
|
|
1290
|
-
*
|
|
1291
|
-
* @returns CurrentUsersResponse User analytics metrics with comparison data
|
|
1292
|
-
* @throws ApiError
|
|
1293
|
-
*/
|
|
1294
|
-
public static analyticsUsersRetrieve({
|
|
1295
|
-
metric,
|
|
1296
|
-
dateFilter = 'today',
|
|
1297
|
-
endDate,
|
|
1298
|
-
granularity = 'hour',
|
|
1299
|
-
mentorUniqueId,
|
|
1300
|
-
platformKey,
|
|
1301
|
-
startDate,
|
|
1302
|
-
}: {
|
|
1303
|
-
/**
|
|
1304
|
-
* * `currently_active` - Users logged in right now
|
|
1305
|
-
* * `active_users` - Active users in a period
|
|
1306
|
-
* * `registered_users` - Registered users
|
|
1307
|
-
* * `active_users_last_30d` - Active users in the last 30 days
|
|
1308
|
-
*/
|
|
1309
|
-
metric: 'currently_active' | 'active_users' | 'registered_users' | 'active_users_last_30d',
|
|
1310
|
-
/**
|
|
1311
|
-
* * `today` - Today only
|
|
1312
|
-
* * `7d` - Last 7 days
|
|
1313
|
-
* * `30d` - Last 30 days
|
|
1314
|
-
* * `90d` - Last 90 days
|
|
1315
|
-
* * `all_time` - All time
|
|
1316
|
-
* * `custom` - Custom date range
|
|
1317
|
-
*/
|
|
1318
|
-
dateFilter?: 'today' | '7d' | '30d' | '90d' | 'all_time' | 'custom',
|
|
1319
|
-
endDate?: string,
|
|
1320
|
-
/**
|
|
1321
|
-
* * `day` - day
|
|
1322
|
-
* * `hour` - hour
|
|
1323
|
-
* * `week` - week
|
|
1324
|
-
* * `month` - month
|
|
1325
|
-
*/
|
|
1326
|
-
granularity?: 'day' | 'hour' | 'week' | 'month',
|
|
1327
|
-
mentorUniqueId?: string,
|
|
1328
|
-
platformKey?: string,
|
|
1329
|
-
startDate?: string,
|
|
1330
|
-
}): CancelablePromise<CurrentUsersResponse> {
|
|
1331
|
-
return __request(OpenAPI, {
|
|
1332
|
-
method: 'GET',
|
|
1333
|
-
url: '/api/analytics/users/',
|
|
1334
|
-
query: {
|
|
1335
|
-
'date_filter': dateFilter,
|
|
1336
|
-
'end_date': endDate,
|
|
1337
|
-
'granularity': granularity,
|
|
1338
|
-
'mentor_unique_id': mentorUniqueId,
|
|
1339
|
-
'metric': metric,
|
|
1340
|
-
'platform_key': platformKey,
|
|
1341
|
-
'start_date': startDate,
|
|
1342
|
-
},
|
|
1343
|
-
errors: {
|
|
1344
|
-
400: `Bad Request - Invalid parameters`,
|
|
1345
|
-
403: `Forbidden - Insufficient permissions`,
|
|
1346
|
-
500: `Internal Server Error`,
|
|
1347
|
-
},
|
|
1348
|
-
});
|
|
1349
|
-
}
|
|
1350
|
-
/**
|
|
1351
|
-
*
|
|
1352
|
-
* User Details API - Comprehensive user activity details with search and filtering.
|
|
1353
|
-
*
|
|
1354
|
-
* Provides detailed user information including:
|
|
1355
|
-
* - User contact information (email, full name)
|
|
1356
|
-
* - Activity metrics (message count, last activity)
|
|
1357
|
-
* - Search functionality across multiple fields
|
|
1358
|
-
* - Flexible date range filtering
|
|
1359
|
-
* - CSV export capability
|
|
1360
|
-
*
|
|
1361
|
-
* **Key Features:**
|
|
1362
|
-
* - Full-text search across email, name, and user ID
|
|
1363
|
-
* - Date range filtering for activity periods
|
|
1364
|
-
* - Platform and mentor-specific filtering
|
|
1365
|
-
* - Comprehensive pagination with metadata
|
|
1366
|
-
* - CSV export for data analysis
|
|
1367
|
-
* - User aggregation across platforms/mentors
|
|
1368
|
-
*
|
|
1369
|
-
* **Search Capabilities:**
|
|
1370
|
-
* - Email address matching
|
|
1371
|
-
* - Full name search
|
|
1372
|
-
* - User ID lookup
|
|
1373
|
-
* - Partial string matching (case-insensitive)
|
|
1374
|
-
*
|
|
1375
|
-
* **Export Options:**
|
|
1376
|
-
* - JSON response (default)
|
|
1377
|
-
* - CSV export (?export=csv)
|
|
1378
|
-
* - Includes all user fields in export
|
|
1379
|
-
*
|
|
1380
|
-
* @returns UserDetail Paginated user details with activity metrics
|
|
1381
|
-
* @throws ApiError
|
|
1382
|
-
*/
|
|
1383
|
-
public static analyticsUsersDetailsRetrieve({
|
|
1384
|
-
dateFilter = 'today',
|
|
1385
|
-
endDate,
|
|
1386
|
-
limit = 20,
|
|
1387
|
-
mentorUniqueId,
|
|
1388
|
-
page = 1,
|
|
1389
|
-
platformKey,
|
|
1390
|
-
search,
|
|
1391
|
-
startDate,
|
|
1392
|
-
}: {
|
|
1393
|
-
/**
|
|
1394
|
-
* * `today` - Today only
|
|
1395
|
-
* * `7d` - Last 7 days
|
|
1396
|
-
* * `30d` - Last 30 days
|
|
1397
|
-
* * `90d` - Last 90 days
|
|
1398
|
-
* * `all_time` - All time
|
|
1399
|
-
* * `custom` - Custom date range
|
|
1400
|
-
*/
|
|
1401
|
-
dateFilter?: 'today' | '7d' | '30d' | '90d' | 'all_time' | 'custom',
|
|
1402
|
-
endDate?: string,
|
|
1403
|
-
limit?: number,
|
|
1404
|
-
mentorUniqueId?: string,
|
|
1405
|
-
page?: number,
|
|
1406
|
-
platformKey?: string,
|
|
1407
|
-
/**
|
|
1408
|
-
* Search by email, full name, or user ID
|
|
1409
|
-
*/
|
|
1410
|
-
search?: string,
|
|
1411
|
-
startDate?: string,
|
|
1412
|
-
}): CancelablePromise<UserDetail> {
|
|
1413
|
-
return __request(OpenAPI, {
|
|
1414
|
-
method: 'GET',
|
|
1415
|
-
url: '/api/analytics/users/details/',
|
|
1416
|
-
query: {
|
|
1417
|
-
'date_filter': dateFilter,
|
|
1418
|
-
'end_date': endDate,
|
|
1419
|
-
'limit': limit,
|
|
1420
|
-
'mentor_unique_id': mentorUniqueId,
|
|
1421
|
-
'page': page,
|
|
1422
|
-
'platform_key': platformKey,
|
|
1423
|
-
'search': search,
|
|
1424
|
-
'start_date': startDate,
|
|
1425
|
-
},
|
|
1426
|
-
errors: {
|
|
1427
|
-
400: `Bad Request - Invalid parameters`,
|
|
1428
|
-
403: `Forbidden - Insufficient permissions`,
|
|
1429
|
-
500: `Internal Server Error`,
|
|
1430
|
-
},
|
|
1431
|
-
});
|
|
1432
|
-
}
|
|
1433
|
-
}
|
|
285
|
+
* @returns LearnerListResponse Paginated list of learners with their metrics
|
|
286
|
+
* @throws ApiError
|
|
287
|
+
*/
|
|
288
|
+
public static analyticsLearnersListRetrieve({
|
|
289
|
+
platformKey,
|
|
290
|
+
dateFilter = 'today',
|
|
291
|
+
endDate,
|
|
292
|
+
granularity = 'hour',
|
|
293
|
+
limit = 20,
|
|
294
|
+
page = 1,
|
|
295
|
+
search,
|
|
296
|
+
sortBy = 'last_activity',
|
|
297
|
+
sortOrder = 'desc',
|
|
298
|
+
startDate,
|
|
299
|
+
}: {
|
|
300
|
+
/**
|
|
301
|
+
* Platform key to filter learners by platform
|
|
302
|
+
*/
|
|
303
|
+
platformKey: string,
|
|
304
|
+
/**
|
|
305
|
+
* * `today` - Today only
|
|
306
|
+
* * `7d` - Last 7 days
|
|
307
|
+
* * `30d` - Last 30 days
|
|
308
|
+
* * `90d` - Last 90 days
|
|
309
|
+
* * `all_time` - All time
|
|
310
|
+
* * `custom` - Custom date range
|
|
311
|
+
*/
|
|
312
|
+
dateFilter?: 'today' | '7d' | '30d' | '90d' | 'all_time' | 'custom',
|
|
313
|
+
endDate?: string,
|
|
314
|
+
/**
|
|
315
|
+
* * `day` - day
|
|
316
|
+
* * `hour` - hour
|
|
317
|
+
* * `week` - week
|
|
318
|
+
* * `month` - month
|
|
319
|
+
*/
|
|
320
|
+
granularity?: 'day' | 'hour' | 'week' | 'month',
|
|
321
|
+
/**
|
|
322
|
+
* Number of learners per page (default: 20, max: 100)
|
|
323
|
+
*/
|
|
324
|
+
limit?: number,
|
|
325
|
+
/**
|
|
326
|
+
* Page number for pagination (default: 1)
|
|
327
|
+
*/
|
|
328
|
+
page?: number,
|
|
329
|
+
/**
|
|
330
|
+
* Search term to filter learners by username, email, or name
|
|
331
|
+
*/
|
|
332
|
+
search?: string,
|
|
333
|
+
/**
|
|
334
|
+
* Field to sort learners by (default: last_activity)
|
|
335
|
+
*
|
|
336
|
+
* * `username` - Username
|
|
337
|
+
* * `name` - Name
|
|
338
|
+
* * `last_activity` - Last Activity
|
|
339
|
+
* * `total_points` - Total Points
|
|
340
|
+
* * `total_time_spent_seconds` - Time Spent
|
|
341
|
+
* * `total_enrollments` - Enrollments
|
|
342
|
+
* * `total_skills_count` - Skills Count
|
|
343
|
+
*/
|
|
344
|
+
sortBy?: 'username' | 'name' | 'last_activity' | 'total_points' | 'total_time_spent_seconds' | 'total_enrollments' | 'total_skills_count',
|
|
345
|
+
/**
|
|
346
|
+
* Sort order (default: desc)
|
|
347
|
+
*
|
|
348
|
+
* * `asc` - Ascending
|
|
349
|
+
* * `desc` - Descending
|
|
350
|
+
*/
|
|
351
|
+
sortOrder?: 'asc' | 'desc',
|
|
352
|
+
startDate?: string,
|
|
353
|
+
}): CancelablePromise<LearnerListResponse> {
|
|
354
|
+
return __request(OpenAPI, {
|
|
355
|
+
method: 'GET',
|
|
356
|
+
url: '/api/analytics/learners/list/',
|
|
357
|
+
query: {
|
|
358
|
+
'date_filter': dateFilter,
|
|
359
|
+
'end_date': endDate,
|
|
360
|
+
'granularity': granularity,
|
|
361
|
+
'limit': limit,
|
|
362
|
+
'page': page,
|
|
363
|
+
'platform_key': platformKey,
|
|
364
|
+
'search': search,
|
|
365
|
+
'sort_by': sortBy,
|
|
366
|
+
'sort_order': sortOrder,
|
|
367
|
+
'start_date': startDate,
|
|
368
|
+
},
|
|
369
|
+
errors: {
|
|
370
|
+
400: `Bad Request - Invalid parameters supplied`,
|
|
371
|
+
403: `Forbidden - Platform admin access required`,
|
|
372
|
+
500: `Unexpected error`,
|
|
373
|
+
},
|
|
374
|
+
});
|
|
375
|
+
}
|
|
376
|
+
}
|