n8n/dist/modules/insights/insights.service.d.ts

n8n Workflow Automation Tool

import { type InsightsSummary } from '@n8n/api-types';
import { LicenseState, Logger } from '@n8n/backend-common';
import type { User } from '@n8n/db';
import { InstanceSettings } from 'n8n-core';
import { WorkflowSharingService } from '../../workflows/workflow-sharing.service';
import type { TypeUnit } from './database/entities/insights-shared';
import { InsightsByPeriodRepository } from './database/repositories/insights-by-period.repository';
import { InsightsCompactionService } from './insights-compaction.service';
import { InsightsPruningService } from './insights-pruning.service';
export declare class InsightsService {
    private readonly insightsByPeriodRepository;
    private readonly compactionService;
    private readonly pruningService;
    private readonly licenseState;
    private readonly instanceSettings;
    private readonly logger;
    private readonly workflowSharingService;
    constructor(insightsByPeriodRepository: InsightsByPeriodRepository, compactionService: InsightsCompactionService, pruningService: InsightsPruningService, licenseState: LicenseState, instanceSettings: InstanceSettings, logger: Logger, workflowSharingService: WorkflowSharingService);
    private toggleCollectionService;
    init(): Promise<void>;
    startCompactionAndPruningTimers(): void;
    stopCompactionAndPruningTimers(): Promise<void>;
    shutdown(): Promise<void>;
    private resolveAccessFilter;
    getInsightsSummary({ user, startDate, endDate, projectId, timeZone, }: {
        user: User;
        projectId?: string;
        startDate: Date;
        endDate: Date;
        timeZone?: string;
    }): Promise<InsightsSummary>;
    getInsightsByWorkflow({ user, skip, take, sortBy, projectId, startDate, endDate, timeZone, }: {
        user: User;
        skip?: number;
        take?: number;
        sortBy?: string;
        projectId?: string;
        startDate: Date;
        endDate: Date;
        timeZone?: string;
    }): Promise<{
        count: number;
        data: {
            workflowId: string | null;
            workflowName: string;
            projectId: string | null;
            projectName: string;
            total: number;
            succeeded: number;
            failed: number;
            failureRate: number;
            runTime: number;
            averageRunTime: number;
            timeSaved: number;
            hasReadAccess: boolean;
        }[];
    }>;
    getInsightsByTime({ user, insightTypes, projectId, startDate, endDate, timeZone, }: {
        user: User;
        insightTypes?: TypeUnit[];
        projectId?: string;
        startDate: Date;
        endDate: Date;
        timeZone?: string;
    }): Promise<{
        date: string;
        values: {
            succeeded?: number | undefined;
            failed?: number | undefined;
            timeSaved?: number | undefined;
        } & {
            total?: number;
            successRate?: number;
            failureRate?: number;
            averageRunTime?: number;
        };
    }[]>;
    validateDateFiltersLicense({ startDate, endDate }: {
        startDate: Date;
        endDate: Date;
    }): void;
    private getDateFiltersGranularity;
}