Gets usage data

GET 
/api/admin/metrics/rps

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

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

Whether the query against prometheus succeeded or failed

Possible values: [success, failure]

Example: success

data

object

The query result from prometheus

resultType string

Prometheus compatible result type.

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

Example: vector

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

Example: mySdk

endpoint string

Which endpoint has been accessed

Example: /api/frontend

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

Whether the query against prometheus succeeded or failed

Possible values: [success, failure]

Example: success

data

object

The query result from prometheus

resultType string

Prometheus compatible result type.

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

Example: vector

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

Example: mySdk

endpoint string

Which endpoint has been accessed

Example: /api/frontend

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
            ]
          ]
        }
      ]
    }
  }
}

Loading...