Get feature metrics

GET <your-unleash-url>/api/admin/client-metrics/features/:name/raw

Authorization

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

Get usage metrics for a specific feature for the last 48 hours, grouped by hour

Request

Path Parameters

• name string required

Responses

• 200
• 401
• 403
• 404

---

featureMetricsSchema

application/json

Schema

Schema

• version integer required

  Possible values: >= 1

  The version of this schema

• maturity string required

  The maturity level of this API (alpha, beta, stable, deprecated)

• data object[]required

  Metrics gathered per environment

  Array [

  featureName string

  The name of the feature

  appName string

  The name of the application the SDK is being used in

  environment string required

  Which environment the SDK is being used in

  timestamp objectrequired

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

  oneOf

  MOD1

  string date-time

  An RFC-3339-compliant timestamp.

  MOD2

  integer

  A UNIX timestamp.

  yes integer required

  How many times the toggle evaluated to true

  no integer required

  How many times the toggle evaluated to false

  variants object

  How many times each variant was returned

  property name* integer

  ]

Example (from schema)

{
  "version": 0,
  "maturity": "stable",
  "data": [
    {
      "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
      }
    }
  ]
}

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

• name string

  The name of the error kind

• message string

  A description of what went wrong.

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."
}

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

• name string

  The name of the error kind

• message string

  A description of what went wrong.

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."
}

The requested resource was not found.

application/json

Schema

Schema

• id string

  The ID of the error instance

• name string

  The name of the error kind

• message string

  A description of what went wrong.

Example (from schema)

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

Authorization

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

Request

Base URL

<your-unleash-url>

Security Scheme

apiKeybearerToken

apiKey

name — path required

curl / cURL

curl -L -X GET '<your-unleash-url>/api/admin/client-metrics/features/:name/raw' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'

python / requests

curl -L -X GET '<your-unleash-url>/api/admin/client-metrics/features/:name/raw' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'

go / native

curl -L -X GET '<your-unleash-url>/api/admin/client-metrics/features/:name/raw' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'

nodejs / native

curl -L -X GET '<your-unleash-url>/api/admin/client-metrics/features/:name/raw' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'

ruby / Net::HTTP

curl -L -X GET '<your-unleash-url>/api/admin/client-metrics/features/:name/raw' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'

csharp / httpclient

curl -L -X GET '<your-unleash-url>/api/admin/client-metrics/features/:name/raw' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'

php / cURL

curl -L -X GET '<your-unleash-url>/api/admin/client-metrics/features/:name/raw' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'

java / OkHttp

curl -L -X GET '<your-unleash-url>/api/admin/client-metrics/features/:name/raw' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'

powershell / RestMethod

curl -L -X GET '<your-unleash-url>/api/admin/client-metrics/features/:name/raw' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'