Last hour of usage and a list of applications that have reported seeing this feature flag
GET/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
Responses
- 200
- 401
- 403
- 404
featureUsageSchema
- application/json
- Schema
- Example (from schema)
Schema
Array [
- MOD1
- MOD2
]
The version of this schema
Possible values: >= 1
The maturity level of this API (alpha, beta, stable, deprecated)
stable
The name of the feature
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)
The name of the feature
my.special.feature
The name of the application the SDK is being used in
accounting
Which environment the SDK is being used in
development
timestamp
object
required
The start of the time window these metrics are valid for. The window is usually 1 hour wide
oneOf
An RFC-3339-compliant timestamp.
string
integer
How many times the toggle evaluated to true
974
How many times the toggle evaluated to false
50
variants
object
How many times each variant was returned
A list of applications seen using this feature
["accounting","billing","booking"]
{
"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"
]
}
Authorization information is missing or invalid. Provide a valid API token as the authorization
header, e.g. authorization:*.*.my-admin-token
.
- application/json
- Schema
- Example (from schema)
Schema
The ID of the error instance
9c40958a-daac-400e-98fb-3bb438567008
The name of the error kind
AuthenticationRequired
A description of what went wrong.
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.
{
"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."
}
The provided user credentials are valid, but the user does not have the necessary permissions to perform this operation
- application/json
- Schema
- Example (from schema)
Schema
The ID of the error instance
9c40958a-daac-400e-98fb-3bb438567008
The name of the error kind
NoAccessError
A description of what went wrong.
You need the "UPDATE_ADDON" permission to perform this action in the "development" environment.
{
"id": "9c40958a-daac-400e-98fb-3bb438567008",
"name": "NoAccessError",
"message": "You need the \"UPDATE_ADDON\" permission to perform this action in the \"development\" environment."
}
The requested resource was not found.
- application/json
- Schema
- Example (from schema)
Schema
The ID of the error instance
9c40958a-daac-400e-98fb-3bb438567008
The name of the error kind
NotFoundError
A description of what went wrong.
Could not find the addon with ID "12345".
{
"id": "9c40958a-daac-400e-98fb-3bb438567008",
"name": "NotFoundError",
"message": "Could not find the addon with ID \"12345\"."
}