Skip to main content

Last hour of usage and a list of applications that have reported seeing this feature flag

GET 

<your-unleash-url>/api/admin/client-metrics/features/:name

Separate counts for yes (enabled), no (disabled), as well as how many times each variant was selected during the last hour

Request

Path Parameters

    name stringrequired

Responses

featureUsageSchema

Schema
    versionintegerrequired

    The version of this schema

    Possible values: >= 1

    maturitystringrequired

    The maturity level of this API (alpha, beta, stable, deprecated)

    Example: stable
    featureNamestringrequired

    The name of the feature

    Example: my.special.feature
    lastHourUsage object[]required

    Last hour statistics. Accumulated per feature per environment. Contains counts for evaluations to true (yes) and to false (no)

  • Array [
  • featureNamestring

    The name of the feature

    Example: my.special.feature
    appNamestring

    The name of the application the SDK is being used in

    Example: accounting
    environmentstringrequired

    Which environment the SDK is being used in

    Example: development
    timestamp objectrequired

    The start of the time window these metrics are valid for. The window is usually 1 hour wide

    oneOf
    string

    An RFC-3339-compliant timestamp.

    Example: 2023-07-27T11:23:44Z
    yesintegerrequired

    How many times the toggle evaluated to true

    Example: 974
    nointegerrequired

    How many times the toggle evaluated to false

    Example: 50
    variants object

    How many times each variant was returned

    property name*integer
  • ]
  • seenApplicationsstring[]required

    A list of applications seen using this feature

    Example: ["accounting","billing","booking"]

Authorization: Authorization

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

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