Skip to main content

Instance usage statistics

GET 

<your-unleash-url>/api/admin/instance-admin/statistics

deprecated

This endpoint has been deprecated and may be replaced or removed in future versions of the API.

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.

Responses

instanceAdminStatsSchema

Schema
    instanceIdstringrequired

    A unique identifier for this instance. Generated by the database migration scripts at first run. Typically a UUID.

    Example: ed3861ae-78f9-4e8c-8e57-b57efc15f82b
    timestampdate-timenullable

    When these statistics were produced

    Example: 2023-06-12T12:25:06Z
    versionOSSstring

    The version of Unleash OSS that is bundled in this instance

    Example: 5.1.7
    versionEnterprisestring

    The version of Unleash Enterprise that is bundled in this instance

    Example: 5.1.7
    usersinteger

    The number of users this instance has

    Example: 8
    previousDayMetricsBucketsCount object

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

    enabledCountinteger

    The number of enabled/disabled metrics buckets recorded in the previous day

    Example: 10
    variantCountinteger

    The number of variant metrics buckets recorded in the previous day

    Example: 10
    activeUsers object

    The number of active users in the last 7, 30 and 90 days

    last7integer

    The number of active users in the last 7 days

    Example: 5
    last30integer

    The number of active users in the last 30 days

    Example: 10
    last60integer

    The number of active users in the last 60 days

    Example: 12
    last90integer

    The number of active users in the last 90 days

    Example: 15
    licensedUsersinteger

    The number of users who had access to Unleash within the last 30 days, including those who may have been deleted during this period.

    Example: 10
    productionChanges object

    The number of changes to the production environment in the last 30, 60 and 90 days

    last30integer

    The number of changes in production in the last 30 days

    Example: 10
    last60integer

    The number of changes in production in the last 60 days

    Example: 12
    last90integer

    The number of changes in production in the last 90 days

    Example: 15
    featureTogglesinteger

    The number of feature-toggles this instance has

    Example: 47
    projectsinteger

    The number of projects defined in this instance.

    Example: 3
    contextFieldsinteger

    The number of context fields defined in this instance.

    Example: 7
    rolesinteger

    The number of roles defined in this instance

    Example: 5
    groupsinteger

    The number of groups defined in this instance

    Example: 12
    environmentsinteger

    The number of environments defined in this instance

    Example: 3
    segmentsinteger

    The number of segments defined in this instance

    Example: 19
    strategiesinteger

    The number of strategies defined in this instance

    Example: 8
    SAMLenabledboolean

    Whether or not SAML authentication is enabled for this instance

    Example: false
    OIDCenabledboolean

    Whether or not OIDC authentication is enabled for this instance

    Example: true
    clientApps object[]

    A count of connected applications in the last week, last month and all time since last restart

  • Array [
  • rangestring

    A description of a time range

    Possible values: [allTime, 30d, 7d]

    Example: 30d
    countinteger

    The number of client applications that have been observed in this period

    Example: 1
  • ]
  • featureExportsinteger

    The number of export operations on this instance

    Example: 0
    featureImportsinteger

    The number of import operations on this instance

    Example: 0
    apiTokens object

    The number of API tokens in Unleash, split by type

    admininteger

    The number of admin tokens.

    Example: 5
    clientinteger

    The number of client tokens.

    Example: 5
    frontendinteger

    The number of frontend tokens.

    Example: 5
    maxEnvironmentStrategiesinteger

    The highest number of strategies used on a single feature flag in a single environment.

    Example: 3
    maxConstraintsinteger

    The highest number of constraints used on a single strategy.

    Example: 4
    maxConstraintValuesinteger

    The highest number of constraint values used on a single constraint.

    Example: 17
    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

    Example: b023323477abb1eb145bebf3cdb30a1c2063e3edc1f7ae474ed8ed6c80de9a3b

Authorization: Authorization

name: Authorizationtype: apiKeyin: headerdescription: API key needed to access this API
curl -L '<your-unleash-url>/api/admin/instance-admin/statistics' \
-H 'Accept: application/json' \
-H 'Authorization: <Authorization>'
Request Collapse all
Base URL
<your-unleash-url>
Auth
ResponseClear

Click the Send API Request button above and see the response here!