Client APIMetrics

Register client usage metrics

View as Markdown
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
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
bucketobject or nullOptional
Holds all metrics gathered over a window of time. Typically 1 hour wide. May be omitted or null when the request only carries impact metrics.

Response

This response has no body.

Errors

400
Bad Request Error