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

200

featureUsageSchema

application/json

Schema

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
MOD1
string
An RFC-3339-compliant timestamp.
Example: 2023-07-27T11:23:44Z
MOD2
integer
A UNIX timestamp.
Example: 1690449593
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"]

Example (auto)

{
  "version": 0,
  "maturity": "stable",
  "featureName": "my.special.feature",
  "lastHourUsage": [
    {
      "featureName": "my.special.feature",
      "appName": "accounting",
      "environment": "development",
      "timestamp": "2023-07-27T11:23:44Z",
      "yes": 974,
      "no": 50,
      "variants": {
        "variantA": 15,
        "variantB": 25,
        "variantC": 5
      }
    }
  ],
  "seenApplications": [
    "accounting",
    "billing",
    "booking"
  ]
}

401

Authorization information is missing or invalid. Provide a valid API token as the authorization header, e.g. authorization:*.*.my-admin-token.

application/json

Schema

Schema

idstring
The ID of the error instance
Example: 9c40958a-daac-400e-98fb-3bb438567008
namestring
The name of the error kind
Example: AuthenticationRequired
messagestring
A description of what went wrong.
Example: You must log in to use Unleash. Your request had no authorization header, so we could not authorize you. Try logging in at /auth/simple/login.

Example (auto)

{
  "id": "9c40958a-daac-400e-98fb-3bb438567008",
  "name": "AuthenticationRequired",
  "message": "You must log in to use Unleash. Your request had no authorization header, so we could not authorize you. Try logging in at /auth/simple/login."
}

403

The provided user credentials are valid, but the user does not have the necessary permissions to perform this operation

application/json

Schema

Schema

idstring
The ID of the error instance
Example: 9c40958a-daac-400e-98fb-3bb438567008
namestring
The name of the error kind
Example: NoAccessError
messagestring
A description of what went wrong.
Example: You need the "UPDATE_ADDON" permission to perform this action in the "development" environment.

Example (auto)

{
  "id": "9c40958a-daac-400e-98fb-3bb438567008",
  "name": "NoAccessError",
  "message": "You need the \"UPDATE_ADDON\" permission to perform this action in the \"development\" environment."
}

404

The requested resource was not found.

application/json

Schema

Schema

idstring
The ID of the error instance
Example: 9c40958a-daac-400e-98fb-3bb438567008
namestring
The name of the error kind
Example: NotFoundError
messagestring
A description of what went wrong.
Example: Could not find the addon with ID "12345".

Example (auto)

{
  "id": "9c40958a-daac-400e-98fb-3bb438567008",
  "name": "NotFoundError",
  "message": "Could not find the addon with ID \"12345\"."
}

Authorization: Authorization

name: Authorizationtype: apiKeyin: headerdescription: API key needed to access this API

• curl
• python
• go
• nodejs
• ruby
• csharp
• php
• java
• powershell

• CURL

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

Security Scheme

apiKeybearerToken

apiKey

Parameters

name — pathrequired

ResponseClear

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