Skip to main content

Instance usage statistics

GET 
/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

    instanceId stringrequired

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

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

    When these statistics were produced

    Example: 2023-06-12T12:25:06Z
    versionOSS string

    The version of Unleash OSS that is bundled in this instance

    Example: 5.1.7
    versionEnterprise string

    The version of Unleash Enterprise that is bundled in this instance

    Example: 5.1.7
    users integer

    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

    enabledCount integer

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

    Example: 10
    variantCount integer

    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

    last7 integer

    The number of active users in the last 7 days

    Example: 5
    last30 integer

    The number of active users in the last 30 days

    Example: 10
    last60 integer

    The number of active users in the last 60 days

    Example: 12
    last90 integer

    The number of active users in the last 90 days

    Example: 15

    productionChanges

    object

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

    last30 integer

    The number of changes in production in the last 30 days

    Example: 10
    last60 integer

    The number of changes in production in the last 60 days

    Example: 12
    last90 integer

    The number of changes in production in the last 90 days

    Example: 15
    featureToggles integer

    The number of feature-toggles this instance has

    Example: 47
    projects integer

    The number of projects defined in this instance.

    Example: 3
    contextFields integer

    The number of context fields defined in this instance.

    Example: 7
    roles integer

    The number of roles defined in this instance

    Example: 5
    groups integer

    The number of groups defined in this instance

    Example: 12
    environments integer

    The number of environments defined in this instance

    Example: 3
    segments integer

    The number of segments defined in this instance

    Example: 19
    strategies integer

    The number of strategies defined in this instance

    Example: 8
    SAMLenabled boolean

    Whether or not SAML authentication is enabled for this instance

    Example: false
    OIDCenabled boolean

    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 [

    • range string

    A description of a time range

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

    Example: 30d
    count integer

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

    Example: 1

  • ]

    • featureExports integer

    The number of export operations on this instance

    Example: 0
    featureImports integer

    The number of import operations on this instance

    Example: 0

    apiTokens

    object

    The number of API tokens in Unleash, split by type

    admin integer

    The number of admin tokens.

    Example: 5
    client integer

    The number of client tokens.

    Example: 5
    frontend integer

    The number of frontend tokens.

    Example: 5
    maxEnvironmentStrategies integer

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

    Example: 3
    maxConstraints integer

    The highest number of constraints used on a single strategy.

    Example: 4
    maxConstraintValues integer

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

    Example: 17
    sum string

    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
Loading...