Admin APIInstance admin

Get instance statistics

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 or null
The version of Unleash OSS that is bundled in this instance
versionEnterprisestring or null
The version of Unleash Enterprise that is bundled in this instance
usersinteger or null>=0
The number of users this instance has
previousDayMetricsBucketsCountobject or null

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

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

The number of feature-toggles this instance has

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

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