Admin APIInstance admin

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 nullformat: "date-time"
When these statistics were produced
versionOSSstring
The version of Unleash OSS that is bundled in this instance
versionEnterprisestring
The version of Unleash Enterprise that is bundled in this instance
usersinteger>=0
The number of users this instance has
previousDayMetricsBucketsCountobject

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

activeUsersobject
The number of active users in the last 7, 30 and 90 days
licensedUsersinteger>=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.
productionChangesobject
The number of changes to the production environment in the last 30, 60 and 90 days
featureTogglesinteger>=0

The number of feature-toggles this instance has

projectsinteger>=0
The number of projects defined in this instance.
contextFieldsinteger>=0
The number of context fields defined in this instance.
rolesinteger>=0
The number of roles defined in this instance
groupsinteger>=0
The number of groups defined in this instance
environmentsinteger>=0
The number of environments defined in this instance
segmentsinteger>=0
The number of segments defined in this instance
strategiesinteger>=0
The number of strategies defined in this instance
SAMLenabledboolean
Whether or not SAML authentication is enabled for this instance
OIDCenabledboolean
Whether or not OIDC authentication is enabled for this instance
clientAppslist of objects
A count of connected applications in the last week, last month and all time since last restart
featureExportsinteger>=0
The number of export operations on this instance
featureImportsinteger>=0
The number of import operations on this instance
apiTokensobject
The number of API tokens in Unleash, split by type
maxEnvironmentStrategiesinteger>=0
The highest number of strategies used on a single feature flag in a single environment.
maxConstraintsinteger>=0
The highest number of constraints used on a single strategy.
maxConstraintValuesinteger>=0
The highest number of constraint values used on a single constraint.
releaseTemplatesinteger>=0
The number of release templates in this instance
releasePlansinteger>=0
The number of release plans in this instance
edgeInstanceUsagemap from strings to doubles
The average number of edge instances, per month, in the last 12 months, rounded to 3 decimal places
readOnlyUsersinteger>=0
The number of ReadOnly users in this instance
sumstring

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