Gets usage data | Unleash Documentation

curl https://app.unleash-instance.example.com/api/admin/metrics/rps \
     -H "Authorization: <apiKey>"

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

Enterprise feature

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

Authentication

Authorizationstring

API key needed to access this API

AuthorizationBearer

API key needed to access this API, in Bearer token format

Response

requestsPerSecondSegmentedSchema

clientMetricsobject

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

adminMetricsobject

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

1	{
2	"clientMetrics": {
3	"status": "success",
4	"data": {
5	"resultType": "vector",
6	"result": [
7	{
8	"metric": {
9	"appName": "mySdk",
10	"endpoint": "/api/frontend"
11	},
12	"values": [
13	[
14	"string"
15	]
16	]
17	}
18	]
19	}
20	},
21	"adminMetrics": {
22	"status": "success",
23	"data": {
24	"resultType": "vector",
25	"result": [
26	{
27	"metric": {
28	"appName": "mySdk",
29	"endpoint": "/api/frontend"
30	},
31	"values": [
32	[
33	"string"
34	]
35	]
36	}
37	]
38	}
39	}
40	}

1	{
2	"clientMetrics": {
3	"status": "success",
4	"data": {
5	"resultType": "vector",
6	"result": [
7	{
8	"metric": {
9	"appName": "mySdk",
10	"endpoint": "/api/frontend"
11	},
12	"values": [
13	[
14	"string"
15	]
16	]
17	}
18	]
19	}
20	},
21	"adminMetrics": {
22	"status": "success",
23	"data": {
24	"resultType": "vector",
25	"result": [
26	{
27	"metric": {
28	"appName": "mySdk",
29	"endpoint": "/api/frontend"
30	},
31	"values": [
32	[
33	"string"
34	]
35	]
36	}
37	]
38	}
39	}
40	}

$	curl https://app.unleash-instance.example.com/api/admin/metrics/rps \
>	-H "Authorization: <apiKey>"