Client APIMetrics

Register client usage metrics

Registers usage metrics. Stores information about how many times each flag was evaluated to enabled and disabled within a time frame. If provided, this operation will also store data on how many times each feature flag's variants were displayed to the end user.

Authentication

Authorizationstring
API key needed to access this API
OR
AuthorizationBearer
API key needed to access this API, in Bearer token format

Request

clientMetricsSchema
appNamestringRequired
The name of the application that is evaluating toggles
bucketobjectRequired
Holds all metrics gathered over a window of time. Typically 1 hour wide
instanceIdstringOptional

A (somewhat) unique identifier for the application

sdkVersionstringOptional

An SDK version identifier. Usually formatted as “unleash-client-<language>:<version>”

platformNamestringOptional
The platform the application is running on. For languages that compile to binaries, this can be omitted
platformVersionstringOptional
The version of the platform the application is running on. Languages that compile to binaries, this is expected to be the compiler version used to assemble the binary.
yggdrasilVersionstringOptional
The semantic version of the Yggdrasil engine used by the client. If the client is using a native engine this can be omitted.
specVersionstringOptional
The version of the Unleash client specification the client supports
environmentstringOptionalDeprecated
Which environment the application is running in. This property was deprecated in v5. This can be determined by the API key calling this endpoint.

Response

This response has no body.

Errors