unleash-server

import type { FromSchema } from 'json-schema-to-ts'; export declare const instanceAdminStatsSchema: { readonly $id: "#/components/schemas/instanceAdminStatsSchema"; readonly type: "object"; readonly additionalProperties: false; readonly description: "Information about an instance and statistics about usage of various features of Unleash"; readonly required: readonly ["instanceId"]; readonly properties: { readonly instanceId: { readonly type: "string"; readonly description: "A unique identifier for this instance. Generated by the database migration scripts at first run. Typically a UUID."; readonly example: "ed3861ae-78f9-4e8c-8e57-b57efc15f82b"; }; readonly timestamp: { readonly type: "string"; readonly format: "date-time"; readonly nullable: true; readonly description: "When these statistics were produced"; readonly example: "2023-06-12T12:25:06Z"; }; readonly versionOSS: { readonly type: "string"; readonly description: "The version of Unleash OSS that is bundled in this instance"; readonly example: "5.1.7"; }; readonly versionEnterprise: { readonly type: "string"; readonly description: "The version of Unleash Enterprise that is bundled in this instance"; readonly example: "5.1.7"; }; readonly users: { readonly type: "integer"; readonly description: "The number of users this instance has"; readonly example: 8; readonly minimum: 0; }; readonly previousDayMetricsBucketsCount: { readonly type: "object"; readonly description: "The number client metrics buckets records recorded in the previous day. # features * # apps * # envs * # hours with metrics"; readonly properties: { readonly enabledCount: { readonly type: "integer"; readonly description: "The number of enabled/disabled metrics buckets recorded in the previous day"; readonly example: 10; readonly minimum: 0; }; readonly variantCount: { readonly type: "integer"; readonly description: "The number of variant metrics buckets recorded in the previous day"; readonly example: 10; readonly minimum: 0; }; }; }; readonly activeUsers: { readonly type: "object"; readonly description: "The number of active users in the last 7, 30 and 90 days"; readonly properties: { readonly last7: { readonly type: "integer"; readonly description: "The number of active users in the last 7 days"; readonly example: 5; readonly minimum: 0; }; readonly last30: { readonly type: "integer"; readonly description: "The number of active users in the last 30 days"; readonly example: 10; readonly minimum: 0; }; readonly last60: { readonly type: "integer"; readonly description: "The number of active users in the last 60 days"; readonly example: 12; readonly minimum: 0; }; readonly last90: { readonly type: "integer"; readonly description: "The number of active users in the last 90 days"; readonly example: 15; readonly minimum: 0; }; }; }; readonly licensedUsers: { readonly type: "integer"; readonly description: "The number of users who had access to Unleash within the last 30 days, including those who may have been deleted during this period."; readonly example: 10; readonly minimum: 0; }; readonly productionChanges: { readonly type: "object"; readonly description: "The number of changes to the production environment in the last 30, 60 and 90 days"; readonly properties: { readonly last30: { readonly type: "integer"; readonly description: "The number of changes in production in the last 30 days"; readonly example: 10; readonly minimum: 0; }; readonly last60: { readonly type: "integer"; readonly description: "The number of changes in production in the last 60 days"; readonly example: 12; readonly minimum: 0; }; readonly last90: { readonly type: "integer"; readonly description: "The number of changes in production in the last 90 days"; readonly example: 15; readonly minimum: 0; }; }; }; readonly featureToggles: { readonly type: "integer"; readonly description: "The number of feature-toggles this instance has"; readonly example: 47; readonly minimum: 0; }; readonly projects: { readonly type: "integer"; readonly description: "The number of projects defined in this instance."; readonly example: 3; readonly minimum: 0; }; readonly contextFields: { readonly type: "integer"; readonly description: "The number of context fields defined in this instance."; readonly example: 7; readonly minimum: 0; }; readonly roles: { readonly type: "integer"; readonly description: "The number of roles defined in this instance"; readonly example: 5; readonly minimum: 0; }; readonly groups: { readonly type: "integer"; readonly description: "The number of groups defined in this instance"; readonly example: 12; readonly minimum: 0; }; readonly environments: { readonly type: "integer"; readonly description: "The number of environments defined in this instance"; readonly example: 3; readonly minimum: 0; }; readonly segments: { readonly type: "integer"; readonly description: "The number of segments defined in this instance"; readonly example: 19; readonly minimum: 0; }; readonly strategies: { readonly type: "integer"; readonly description: "The number of strategies defined in this instance"; readonly example: 8; readonly minimum: 0; }; readonly SAMLenabled: { readonly type: "boolean"; readonly description: "Whether or not SAML authentication is enabled for this instance"; readonly example: false; }; readonly OIDCenabled: { readonly type: "boolean"; readonly description: "Whether or not OIDC authentication is enabled for this instance"; readonly example: true; }; readonly clientApps: { readonly type: "array"; readonly description: "A count of connected applications in the last week, last month and all time since last restart"; readonly items: { readonly type: "object"; readonly description: "An entry describing how many client applications has been observed over the defined range"; readonly properties: { readonly range: { readonly type: "string"; readonly description: "A description of a time range"; readonly enum: readonly ["allTime", "30d", "7d"]; readonly example: "30d"; }; readonly count: { readonly type: "integer"; readonly description: "The number of client applications that have been observed in this period"; readonly example: 1; }; }; }; }; readonly featureExports: { readonly type: "integer"; readonly description: "The number of export operations on this instance"; readonly example: 0; readonly minimum: 0; }; readonly featureImports: { readonly type: "integer"; readonly description: "The number of import operations on this instance"; readonly example: 0; readonly minimum: 0; }; readonly apiTokens: { readonly type: "object"; readonly description: "The number of API tokens in Unleash, split by type"; readonly properties: { readonly admin: { readonly type: "integer"; readonly description: "The number of admin tokens."; readonly minimum: 0; readonly example: 5; }; readonly client: { readonly type: "integer"; readonly description: "The number of client tokens."; readonly minimum: 0; readonly example: 5; }; readonly frontend: { readonly type: "integer"; readonly description: "The number of frontend tokens."; readonly minimum: 0; readonly example: 5; }; }; }; readonly maxEnvironmentStrategies: { readonly type: "integer"; readonly minimum: 0; readonly example: 3; readonly description: "The highest number of strategies used on a single feature flag in a single environment."; }; readonly maxConstraints: { readonly type: "integer"; readonly minimum: 0; readonly example: 4; readonly description: "The highest number of constraints used on a single strategy."; }; readonly maxConstraintValues: { readonly type: "integer"; readonly minimum: 0; readonly example: 17; readonly description: "The highest number of constraint values used on a single constraint."; }; readonly releaseTemplates: { readonly type: "integer"; readonly minimum: 0; readonly example: 2; readonly description: "The number of release templates in this instance"; }; readonly releasePlans: { readonly type: "integer"; readonly minimum: 0; readonly example: 1; readonly description: "The number of release plans in this instance"; }; readonly edgeInstanceUsage: { readonly type: "object"; readonly description: "The average number of edge instances, per month, in the last 12 months, rounded to 3 decimal places"; readonly additionalProperties: { readonly type: "number"; readonly minimum: 0; }; readonly example: { readonly '2025-09': 2.25; readonly '2025-08': 1.75; readonly '2024-10': 0.45; }; }; readonly sum: { readonly type: "string"; readonly description: "A SHA-256 checksum of the instance statistics to be used to verify that the data in this object has not been tampered with"; readonly example: "b023323477abb1eb145bebf3cdb30a1c2063e3edc1f7ae474ed8ed6c80de9a3b"; }; }; readonly components: {}; }; export type InstanceAdminStatsSchema = FromSchema<typeof instanceAdminStatsSchema>; //# sourceMappingURL=instance-admin-stats-schema.d.ts.map