@iblai/web-utils 1.11.7 → 1.11.9

package/dist/data-layer/src/features/analytics/types.d.ts

@@ -1,696 +0,0 @@
-export type AggregationType = 'daily' | 'hourly' | 'weekly' | 'monthly';
-export interface AnalyticsBaseParams {
-    org: string;
-    userId: string;
-    mentorId: string;
-}
-export interface AnalyticsDateParams extends AnalyticsBaseParams {
-    startDate: string;
-    endDate: string;
-    aggregation: AggregationType;
-}
-export interface AnalyticsPaginationParams extends AnalyticsDateParams {
-    page: number;
-    pageSize: number;
-}
-export interface OverviewSummaryResponse {
-    conversation_volume: {
-        total: number;
-        change: number;
-    };
-    users: {
-        total: number;
-        change: number;
-    };
-    topics: {
-        total: number;
-        change: number;
-    };
-    user_rating: {
-        total: number;
-        change: number;
-    };
-}
-export interface ConversationSummaryResponse {
-    date: string;
-    conversation_count: number;
-}
-export interface TopicStatisticsResponse {
-    count: number;
-    next: string | null;
-    previous: string | null;
-    results: Array<{
-        name: string;
-        conversations: number;
-        messages: number;
-        avg_rating: string;
-    }>;
-}
-export interface TranscriptsMessagesArgs {
-    mentor_unique_id?: string;
-    search?: string;
-    topic?: string;
-    platform_key: string;
-    page?: number;
-    limit?: number;
-    usergroup_ids?: number[];
-}
-export interface TranscriptsMessagesDetailsArgs {
-    session_id: string;
-    platform_key: string;
-    mentor_unique_id?: string;
-}
-export interface TranscriptsMessagesDetailsResponse {
-    summary: {
-        platform_name: string;
-        platform_key: string;
-        mentor: string;
-        mentor_unique_id: string;
-        model: string;
-        username: string;
-        name: string;
-        first_user_message: string;
-        topics: string[];
-        message_count: number;
-        user_queries: number;
-        assistant_responses: number;
-        average_sentiment: number;
-        sentiment: string;
-        created_at: string;
-        platform: number;
-        session: string;
-        user: number;
-    };
-    messages: Array<{
-        human: string;
-        ai: string;
-    }>;
-}
-export interface TranscriptsMessagesResponse {
-    summary: {
-        total_conversations: number;
-        user_queries: number;
-        assistant_responses: number;
-        average_sentiment_score: number;
-    };
-    results: Array<{
-        platform_name: string;
-        platform_key: string;
-        mentor: string;
-        mentor_unique_id: string;
-        model: string;
-        cost: number;
-        username: string;
-        name: string;
-        first_user_message: string;
-        topics: string[];
-        message_count: number;
-        user_queries: number;
-        assistant_responses: number;
-        average_sentiment: number;
-        sentiment: string;
-        created_at: string;
-        platform: number;
-        session: string;
-        user: number;
-    }>;
-    pagination: {
-        page: number;
-        limit: number;
-        total_pages: number;
-        total_records: number;
-        has_next: boolean;
-        has_previous: boolean;
-        next_page: number | null;
-        previous_page: number | null;
-    };
-}
-export interface TopicOverviewResponse {
-    total_topics: number;
-    total_topics_change_percentage: number;
-    new_topics: number;
-    new_topics_change_percentage: number;
-}
-export interface UserMetricsResponse {
-    registered_users: {
-        total: number;
-        change_percentage: number;
-    };
-    new_users: {
-        total: number;
-        change_percentage: number;
-    };
-    unique_users: {
-        total: number;
-        change_percentage: number;
-    };
-    veteran_users: {
-        total: number;
-        change_percentage: number;
-    };
-}
-export interface UserMetricsPieChartResponse {
-    new_users: {
-        count: number;
-        percentage: number;
-    };
-    returning_users: {
-        count: number;
-        percentage: number;
-    };
-}
-export interface UserCohortsOverTimeResponse {
-    periods: string[];
-    new_users: number[];
-    veteran_users: number[];
-}
-export interface TopStudentsResponse {
-    username: string;
-    chat_message_count: number;
-}
-export interface TopicsSummaryResponse {
-    name: string;
-    conversation_count: number;
-}
-export interface AverageMessagesPerSessionResponse {
-    time: string;
-    avg_messages: number;
-    total_sessions: number;
-}
-export type DateFilter = 'today' | '30d' | '7d' | '90d' | 'all_time' | 'custom';
-export interface TopicsStatsArgs {
-    date_filter: DateFilter;
-    platform_key: string;
-    mentor_unique_id?: string;
-    usergroup_ids?: number[];
-}
-export interface TopicsStatsResponse {
-    topics: {
-        all_time_total: number;
-        this_month: number;
-        last_month: number;
-        percentage_change: number;
-    };
-    conversations: {
-        all_time_total: number;
-        this_month: number;
-        last_month: number;
-        percentage_change: number;
-    };
-    messages: {
-        all_time_total: number;
-        this_month: number;
-        last_month: number;
-        percentage_change: number;
-    };
-}
-export interface UsersStatsResponse {
-    points: Array<{
-        date: string;
-        value: number;
-    }>;
-    metric: string;
-    count: number;
-    change: number;
-    percentage_change: number;
-}
-export interface UsersStatsArgs {
-    date_filter: DateFilter;
-    platform_key: string;
-    metric?: string;
-    start_date?: string;
-    end_date?: string;
-    mentor_unique_id?: string;
-    usergroup_ids?: number[];
-}
-export interface SessionStatsArgs {
-    platform_key: string;
-    mentor_unique_id?: string;
-    date_filter?: string;
-    start_date?: string;
-    end_date?: string;
-    metric?: string;
-    usergroup_ids?: number[];
-}
-export interface SessionStatsResponse {
-    metric: string;
-    points: Array<{
-        date: string;
-        value: number;
-    }>;
-    avg_messages_per_session?: {
-        value: number;
-        prev_value: number;
-        percentage_change: number;
-    };
-    avg_rating?: {
-        value: number;
-        prev_value: number;
-        percentage_change: number;
-    };
-    avg_cost_per_session?: {
-        value: number;
-        prev_value: number;
-        percentage_change: number;
-    };
-}
-export interface TopicsDetailsStatsArgs {
-    date_filter: string;
-    platform_key: string;
-    start_date?: string;
-    end_date?: string;
-    mentor_unique_id?: string;
-    usergroup_ids?: number[];
-}
-export interface TopicsDetailsStatsResponse {
-    results: Array<{
-        topic_id: number;
-        name: string;
-        messages: number;
-        conversations: number;
-        average_rating: string;
-        rating_count: number;
-    }>;
-    pagination: {
-        page: number;
-        limit: number;
-        total_pages: number;
-        total_records: number;
-        has_next: boolean;
-        has_previous: boolean;
-        next_page: number;
-        previous_page: number;
-    };
-}
-export interface AccessTimeHeatmapArgs {
-    date_filter: string;
-    platform_key: string;
-    start_date?: string;
-    end_date?: string;
-    mentor_unique_id?: string;
-    usergroup_ids?: number[];
-}
-export interface AccessTimeHeatmapResponse {
-    metric: string;
-    data: Array<{
-        day_of_week: number;
-        hour: number;
-        value: number;
-    }>;
-}
-export interface UserDetailsStatsArgs {
-    date_filter: string;
-    platform_key: string;
-    start_date?: string;
-    end_date?: string;
-    page: number;
-    limit?: number;
-    mentor_unique_id?: string;
-    search?: string;
-    usergroup_ids?: number[];
-}
-export interface UserDetailsStatsResponse {
-    results: Array<{
-        email: string;
-        full_name: string;
-        messages: number;
-        last_activity: string;
-    }>;
-    total: number;
-    pagination: {
-        page: number;
-        limit: number;
-        total_pages: number;
-        has_next: boolean;
-        has_previous: boolean;
-        start_index: number;
-        end_index: number;
-    };
-}
-export interface FinancialStatsArgs {
-    metric: 'total_costs' | 'weekly_costs' | 'monthly_costs';
-    date_filter?: DateFilter;
-    platform_key: string;
-    mentor_unique_id?: string;
-    start_date?: string;
-    end_date?: string;
-    all_time?: 'true';
-    usergroup_ids?: number[];
-}
-export interface FinancialStatsFilters {
-    start_date: string;
-    end_date: string;
-    granularity: string;
-    all_time: boolean;
-}
-export interface FinancialStatsPeriodInfo {
-    start_date: string;
-    end_date: string;
-    period_days: number;
-    range_type: string;
-}
-export interface FinancialStatsResponse {
-    metric: string;
-    filters: FinancialStatsFilters;
-    value: number;
-    percentage_change: number | undefined;
-    overtime: Array<{
-        date: string;
-        value: number;
-    }>;
-    period_info: FinancialStatsPeriodInfo;
-    comparison_info: Record<string, any>;
-}
-export interface DetailedFinancialStatsArgs {
-    metric?: string;
-    metrics?: string;
-    group_by: 'llm_model' | 'provider' | 'username';
-    date_filter: DateFilter;
-    platform_key: string;
-    mentor_unique_id?: string;
-    start_date?: string;
-    end_date?: string;
-    page?: number;
-    limit?: number;
-    search?: string;
-    usergroup_ids?: number[];
-}
-export interface DetailedFinancialStatsMetric {
-    name: string;
-    unit: string;
-    description: string;
-}
-export interface DetailedFinancialStatsResponse {
-    page: number;
-    limit: number;
-    total_pages: number;
-    total_records: number;
-    rows: Record<string, any>[];
-    total_cost: number;
-    metrics: DetailedFinancialStatsMetric[];
-}
-export interface TimeTrackingRequest {
-    timestamp: string;
-    url: string;
-    org: string;
-    count: number;
-    course_id?: number;
-    block_id?: number;
-    session_uuid?: string;
-    mentor_uuid?: string;
-}
-export interface TimeTrackingResponse {
-    message: string;
-    success: true;
-}
-export interface TranscriptsConversationHeadlineArgs {
-    platform_key: string;
-    metric: string;
-    mentor_unique_id?: string;
-    start_date?: string;
-    end_date?: string;
-    date_filter?: string;
-}
-export interface TranscriptsConversationHeadlineResponse {
-    metric: 'headline';
-    avg_messages_per_conversation: {
-        value: number;
-        prev_value: number;
-        percentage_change: number;
-    };
-    avg_rating: {
-        value: number;
-        prev_value: number;
-        percentage_change: number;
-    };
-    avg_cost_per_conversation: {
-        value: number;
-        prev_value: number;
-        percentage_change: number;
-    };
-    points?: Array<{
-        date: string;
-        value: number;
-    }>;
-}
-export interface ContentAnalyticsArgs {
-    metric: string;
-    date_filter?: string;
-    start_date?: string;
-    end_date?: string;
-    include_overtime?: boolean;
-    limit?: number;
-    page?: number;
-    platform_key?: string;
-    mentor_unique_id?: string;
-}
-export interface ContentAnalyticsTotals {
-    total_learners: number;
-    total_enrollments: number;
-    total_time_spent: number;
-    courses: number;
-    active_courses: number;
-    platform_courses: number;
-    external_courses: number;
-    programs: number;
-    active_programs: number;
-    platform_programs: number;
-    external_programs: number;
-    pathways: number;
-    active_pathways: number;
-    platform_pathways: number;
-    external_pathways: number;
-    skills: number;
-    active_skills: number;
-    platform_skills: number;
-    external_skills: number;
-    associated_courses: number;
-    learners_with_skills: number;
-}
-export interface ContentAnalyticsAverages {
-    completion_rate: number;
-    average_rating: number;
-    enrollments_per_course: number;
-    enrollments_per_program: number;
-    enrollments_per_pathway: number;
-    courses_per_skill: number;
-    time_per_learner: number;
-}
-export interface ContentAnalyticsSummary {
-    totals: ContentAnalyticsTotals;
-    averages: ContentAnalyticsAverages;
-    overtime: Array<{
-        date: string;
-        value: number;
-    }>;
-}
-export interface ContentAnalyticsPagination {
-    count: number;
-    next: string | null;
-    previous: string | null;
-    current_page: number;
-    total_pages: number;
-}
-export interface ContentAnalyticsItem {
-    id: string;
-    name: string;
-    slug: string;
-    platform: string;
-    external: boolean;
-    analytics: {
-        enrollments: number;
-        active_enrollments: number;
-        completion_rate: number;
-        avg_rating: number;
-        rating_count: number;
-        associated_courses: number;
-        learners_count: number;
-        total_time_spent: number;
-        avg_time_per_learner: number;
-    };
-    instructor: string;
-    category: string;
-    duration: string;
-    enabled: boolean;
-    created: string;
-    updated: string;
-    metadata: string;
-}
-export interface ContentAnalyticsResponse {
-    metric: string;
-    summary: ContentAnalyticsSummary;
-    pagination: ContentAnalyticsPagination;
-    results: ContentAnalyticsItem[];
-}
-export interface ContentAnalyticsDetailsArgs {
-    content_id: string;
-    metric: string;
-    date_filter?: string;
-    start_date?: string;
-    end_date?: string;
-    include_overtime?: boolean;
-    limit?: number;
-    page?: number;
-    platform_key?: string;
-    mentor_unique_id?: string;
-    search?: string;
-    time_metric?: string;
-}
-export interface ContentAnalyticsContentInfo {
-    id: string;
-    name: string;
-    type: string;
-    slug: string;
-    platform: string;
-    external: boolean;
-    metadata: Record<string, string>;
-}
-export interface ContentAnalyticsDetailsSummary {
-    totals: Record<string, number>;
-    averages: Record<string, number>;
-    time_series: {
-        metric: string;
-        interval: string;
-        data: Array<{
-            period: string;
-            value: number;
-            average: number;
-        }>;
-    };
-}
-export interface ContentAnalyticsLearner {
-    user_id: number;
-    username: string;
-    email: string;
-    name: string;
-    enrollment_date: string;
-    completion_status: string;
-    completion_percentage: number;
-    last_activity: string;
-    rating: number;
-    review: string;
-    details: Record<string, string>;
-}
-export interface ContentAnalyticsDetailsResponse {
-    content_info: ContentAnalyticsContentInfo;
-    summary: ContentAnalyticsDetailsSummary;
-    pagination: ContentAnalyticsPagination;
-    learners: ContentAnalyticsLearner[];
-}
-export interface LearnerDetailsArgs {
-    username: string;
-    platform_key: string;
-    metrics: string;
-    course_id?: string;
-    program_id?: string;
-    include_edx_progress?: boolean;
-}
-export interface LearnerDetailsUser {
-    user_id: number;
-    username: string;
-    email: string;
-    name: string;
-    is_active: boolean;
-    last_active: string;
-    date_joined: string;
-}
-export interface LearnerContentEnrollment {
-    created: string;
-    started: string | null;
-    ended: string | null;
-    active: boolean;
-}
-export interface LearnerContentCompletion {
-    completed: boolean;
-    completion_percentage: number;
-    passed: boolean;
-    passed_date: string | null;
-}
-export interface LearnerEdxCompletionSummary {
-    complete_count: number;
-    incomplete_count: number;
-    locked_count: number;
-}
-export interface LearnerEdxCourseGrade {
-    letter_grade: string | null;
-    percent: number;
-    is_passing: boolean;
-}
-export interface LearnerEdxAssignmentPolicy {
-    type: string;
-    short_label: string;
-    weight: number;
-    num_total: number;
-    num_droppable: number;
-}
-export interface LearnerEdxGradingPolicy {
-    assignment_policies: LearnerEdxAssignmentPolicy[];
-    grade_range: Record<string, number>;
-}
-export interface LearnerEdxSubsectionScore {
-    display_name: string;
-    block_key: string;
-    format?: string;
-    has_graded_assignment: boolean;
-    num_points_earned: number;
-    num_points_possible: number;
-    percent_graded: number;
-    problem_scores: Array<Record<string, unknown>>;
-    learner_has_access: boolean;
-    url: string;
-}
-export interface LearnerEdxSectionScore {
-    display_name: string;
-    subsections: LearnerEdxSubsectionScore[];
-}
-export interface LearnerEdxCertificateData {
-    cert_status: string | null;
-    cert_web_view_url: string | null;
-    download_url: string | null;
-    certificate_available_date: string | null;
-}
-export interface LearnerEdxProgress {
-    completion_summary?: LearnerEdxCompletionSummary;
-    course_grade?: LearnerEdxCourseGrade;
-    enrollment_mode?: string;
-    user_has_passing_grade?: boolean;
-    certificate_data?: LearnerEdxCertificateData;
-    grading_policy?: LearnerEdxGradingPolicy;
-    section_scores?: LearnerEdxSectionScore[];
-}
-export interface LearnerCourseDetail {
-    course_id: string;
-    name: string;
-    platform: string;
-    enrollment: LearnerContentEnrollment;
-    completion: LearnerContentCompletion | null;
-    time_spent: string;
-    time_spent_secs: number;
-    edx_progress?: LearnerEdxProgress | null;
-}
-export interface LearnerProgramDetail {
-    program_id: string;
-    name: string;
-    platform: string;
-    enrollment: LearnerContentEnrollment;
-    completion: LearnerContentCompletion | null;
-    time_spent: string;
-    time_spent_secs: number;
-    edx_progress?: LearnerEdxProgress | null;
-}
-export interface LearnerTimeSpentSummary {
-    courses: unknown[];
-    total_time_spent: string;
-    total_time_spent_secs: number;
-}
-export interface LearnerDetailsData {
-    courses?: LearnerCourseDetail[];
-    programs?: LearnerProgramDetail[];
-    pathways?: Array<Record<string, unknown>>;
-    skills?: Array<Record<string, unknown>>;
-    time_spent?: LearnerTimeSpentSummary;
-}
-export interface LearnerDetailsResponse {
-    user: LearnerDetailsUser;
-    data: LearnerDetailsData;
-}