unleash.unleash/frontend/src/openapi/models/instanceAdminStatsSchema.ts

/**
 * Generated by Orval
 * Do not edit manually.
 * See `gen:api` script in package.json
 */
import type { InstanceAdminStatsSchemaActiveUsers } from './instanceAdminStatsSchemaActiveUsers.js';
import type { InstanceAdminStatsSchemaApiTokens } from './instanceAdminStatsSchemaApiTokens.js';
import type { InstanceAdminStatsSchemaClientAppsItem } from './instanceAdminStatsSchemaClientAppsItem.js';
import type { InstanceAdminStatsSchemaEdgeInstances } from './instanceAdminStatsSchemaEdgeInstances.js';
import type { InstanceAdminStatsSchemaPreviousDayMetricsBucketsCount } from './instanceAdminStatsSchemaPreviousDayMetricsBucketsCount.js';
import type { InstanceAdminStatsSchemaProductionChanges } from './instanceAdminStatsSchemaProductionChanges.js';

/**
 * Information about an instance and statistics about usage of various features of Unleash
 */
export interface InstanceAdminStatsSchema {
    /** The number of active users in the last 7, 30 and 90 days */
    activeUsers?: InstanceAdminStatsSchemaActiveUsers;
    /** The number of API tokens in Unleash, split by type */
    apiTokens?: InstanceAdminStatsSchemaApiTokens;
    /** A count of connected applications in the last week, last month and all time since last restart */
    clientApps?: InstanceAdminStatsSchemaClientAppsItem[];
    /**
     * The number of context fields defined in this instance.
     * @minimum 0
     */
    contextFields?: number;
    /** The rounded up average number of edge instances in the last month and month before last */
    edgeInstances?: InstanceAdminStatsSchemaEdgeInstances;
    /**
     * The number of environments defined in this instance
     * @minimum 0
     */
    environments?: number;
    /**
     * The number of export operations on this instance
     * @minimum 0
     */
    featureExports?: number;
    /**
     * The number of import operations on this instance
     * @minimum 0
     */
    featureImports?: number;
    /**
     * The number of feature-toggles this instance has
     * @minimum 0
     */
    featureToggles?: number;
    /**
     * The number of groups defined in this instance
     * @minimum 0
     */
    groups?: number;
    /** A unique identifier for this instance. Generated by the database migration scripts at first run. Typically a UUID. */
    instanceId: string;
    /**
     * The number of users who had access to Unleash within the last 30 days, including those who may have been deleted during this period.
     * @minimum 0
     */
    licensedUsers?: number;
    /**
     * The highest number of constraints used on a single strategy.
     * @minimum 0
     */
    maxConstraints?: number;
    /**
     * The highest number of constraint values used on a single constraint.
     * @minimum 0
     */
    maxConstraintValues?: number;
    /**
     * The highest number of strategies used on a single feature flag in a single environment.
     * @minimum 0
     */
    maxEnvironmentStrategies?: number;
    /** Whether or not OIDC authentication is enabled for this instance */
    OIDCenabled?: boolean;
    /** The number client metrics buckets records recorded in the previous day. # features * # apps * # envs * # hours with metrics */
    previousDayMetricsBucketsCount?: InstanceAdminStatsSchemaPreviousDayMetricsBucketsCount;
    /** The number of changes to the production environment in the last 30, 60 and 90 days */
    productionChanges?: InstanceAdminStatsSchemaProductionChanges;
    /**
     * The number of projects defined in this instance.
     * @minimum 0
     */
    projects?: number;
    /**
     * The number of release plans in this instance
     * @minimum 0
     */
    releasePlans?: number;
    /**
     * The number of release templates in this instance
     * @minimum 0
     */
    releaseTemplates?: number;
    /**
     * The number of roles defined in this instance
     * @minimum 0
     */
    roles?: number;
    /** Whether or not SAML authentication is enabled for this instance */
    SAMLenabled?: boolean;
    /**
     * The number of segments defined in this instance
     * @minimum 0
     */
    segments?: number;
    /**
     * The number of strategies defined in this instance
     * @minimum 0
     */
    strategies?: number;
    /** A SHA-256 checksum of the instance statistics to be used to verify that the data in this object has not been tampered with */
    sum?: string;
    /**
     * When these statistics were produced
     * @nullable
     */
    timestamp?: string | null;
    /**
     * The number of users this instance has
     * @minimum 0
     */
    users?: number;
    /** The version of Unleash Enterprise that is bundled in this instance */
    versionEnterprise?: string;
    /** The version of Unleash OSS that is bundled in this instance */
    versionOSS?: string;
}