Get instance statistics

View as Markdown

Provides statistics about various features of Unleash to allow for reporting of usage for self-hosted customers. The response contains data such as the number of users, groups, features, strategies, versions, etc.

Authentication

Authorizationstring
API key needed to access this API
OR
AuthorizationBearer
API key needed to access this API, in Bearer token format

Response

instanceAdminStatsSchema
instanceIdstring
A unique identifier for this instance. Generated by the database migration scripts at first run. Typically a UUID.
timestampstring or nullOptionalformat: "date-time"
When these statistics were produced
versionOSSstringOptional
The version of Unleash OSS that is bundled in this instance
versionEnterprisestringOptional
The version of Unleash Enterprise that is bundled in this instance
usersintegerOptional>=0
The number of users this instance has
previousDayMetricsBucketsCountobjectOptional

The number client metrics buckets records recorded in the previous day. # features * # apps * # envs * # hours with metrics

activeUsersobjectOptional
The number of active users in the last 7, 30 and 90 days
licensedUsersintegerOptional>=0
The number of users who had access to Unleash within the last 30 days, including those who may have been deleted during this period.
productionChangesobjectOptional
The number of changes to the production environment in the last 30, 60 and 90 days
featureTogglesintegerOptional>=0

The number of feature-toggles this instance has

projectsintegerOptional>=0
The number of projects defined in this instance.
contextFieldsintegerOptional>=0
The number of context fields defined in this instance.
rolesintegerOptional>=0
The number of roles defined in this instance
groupsintegerOptional>=0
The number of groups defined in this instance
environmentsintegerOptional>=0
The number of environments defined in this instance
segmentsintegerOptional>=0
The number of segments defined in this instance
strategiesintegerOptional>=0
The number of strategies defined in this instance
SAMLenabledbooleanOptional
Whether or not SAML authentication is enabled for this instance
OIDCenabledbooleanOptional
Whether or not OIDC authentication is enabled for this instance
clientAppslist of objectsOptional
A count of connected applications in the last week, last month and all time since last restart
featureExportsintegerOptional>=0
The number of export operations on this instance
featureImportsintegerOptional>=0
The number of import operations on this instance
apiTokensobjectOptional
The number of API tokens in Unleash, split by type
maxEnvironmentStrategiesintegerOptional>=0
The highest number of strategies used on a single feature flag in a single environment.
maxConstraintsintegerOptional>=0
The highest number of constraints used on a single strategy.
maxConstraintValuesintegerOptional>=0
The highest number of constraint values used on a single constraint.
releaseTemplatesintegerOptional>=0
The number of release templates in this instance
releasePlansintegerOptional>=0
The number of release plans in this instance
edgeInstanceUsagemap from strings to doublesOptional
The average number of edge instances, per month, in the last 12 months, rounded to 3 decimal places
readOnlyUsersintegerOptional>=0
The number of ReadOnly users in this instance
sumstringOptional

A SHA-256 checksum of the instance statistics to be used to verify that the data in this object has not been tampered with