Gets usage data

GET <your-unleash-url>/api/admin/metrics/rps

Authorization

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

Gets usage data per app/endpoint from a prometheus compatible metrics endpoint

Request

Responses

• 200

---

requestsPerSecondSegmentedSchema

application/json

Schema

Schema

• clientMetrics object

  Statistics for usage of Unleash, formatted so it can easily be used in a graph

  status string

  Possible values: [success, failure]

  Whether the query against prometheus succeeded or failed

  data object

  The query result from prometheus

  resultType string

  Possible values: [matrix, vector, scalar, string]

  Prometheus compatible result type.

  result object[]

  An array of values per metric. Each one represents a line in the graph labeled by its metric name

  Array [

  metric object

  A key value set representing the metric

  appName string

  Name of the application this metric relates to

  endpoint string

  Which endpoint has been accessed

  values array[]

  An array of arrays. Each element of the array is an array of size 2 consisting of the 2 axis for the graph: in position zero the x axis represented as a number and position one the y axis represented as string

  ]
• adminMetrics object

  Statistics for usage of Unleash, formatted so it can easily be used in a graph

  status string

  Possible values: [success, failure]

  Whether the query against prometheus succeeded or failed

  data object

  The query result from prometheus

  resultType string

  Possible values: [matrix, vector, scalar, string]

  Prometheus compatible result type.

  result object[]

  An array of values per metric. Each one represents a line in the graph labeled by its metric name

  Array [

  metric object

  A key value set representing the metric

  appName string

  Name of the application this metric relates to

  endpoint string

  Which endpoint has been accessed

  values array[]

  An array of arrays. Each element of the array is an array of size 2 consisting of the 2 axis for the graph: in position zero the x axis represented as a number and position one the y axis represented as string

  ]

Example (from schema)

{
  "clientMetrics": {
    "status": "success",
    "data": {
      "resultType": "vector",
      "result": [
        {
          "metric": {
            "appName": "mySdk",
            "endpoint": "/api/frontend"
          },
          "values": [
            [
              "string",
              0
            ]
          ]
        }
      ]
    }
  },
  "adminMetrics": {
    "status": "success",
    "data": {
      "resultType": "vector",
      "result": [
        {
          "metric": {
            "appName": "mySdk",
            "endpoint": "/api/frontend"
          },
          "values": [
            [
              "string",
              0
            ]
          ]
        }
      ]
    }
  }
}

Authorization

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

Request

Base URL

<your-unleash-url>

Security Scheme

apiKeybearerToken

apiKey

curl / cURL

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

python / requests

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

go / native

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

nodejs / native

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

ruby / Net::HTTP

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

csharp / httpclient

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

php / cURL

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

java / OkHttp

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

powershell / RestMethod

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