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

name stringrequired

Responses

200

featureUsageSchema

application/json

Schema

Schema

version integerrequired

The version of this schema

Possible values: >= 1

maturity stringrequired
The maturity level of this API (alpha, beta, stable, deprecated)
Example: stable
featureName stringrequired
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 [

featureName string

The name of the feature

Example: my.special.feature

appName string

The name of the application the SDK is being used in

Example: accounting

environment stringrequired

Which environment the SDK is being used in

Example: development

timestamp

object

required

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

oneOf

MOD1

An RFC-3339-compliant timestamp.

string

MOD2

A UNIX timestamp.

integer

yes integerrequired

How many times the toggle evaluated to true

Example: 974

no integerrequired

How many times the toggle evaluated to false

Example: 50

variants

object

How many times each variant was returned

property name* integer

]

seenApplications string[]required
A list of applications seen using this feature
Example: ["accounting","billing","booking"]

Example (from schema)

{
  "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

id string
The ID of the error instance
Example: 9c40958a-daac-400e-98fb-3bb438567008
name string
The name of the error kind
Example: AuthenticationRequired
message string
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 (from schema)

{
  "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

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

Example (from schema)

{
  "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

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

Example (from schema)

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

Loading...