Administration

Query user metrics

Query user metrics.

post/_fabric/{fabric}/_api/metrics/query

Request

Path parameters

fabricstring string required

The name of the fabric.

Request body

GeoFabricstring

GeoFabric name

limitinteger

Number of results we want to receive.

metricsstring[]

Array of strings containing the metric names we want to receive.

querytypestring required
  • list: Returns a list of all available metrics
  • get: Returns all the requested metrics
  • sum: Returns sum of all records for each of the requested metrics.
sinceinteger

Unix timestamp in milliseconds of oldest entry we want to receive.

Example request

{
  "GeoFabric": "_system",
  "limit": 10,
  "metrics": [
    "c8cep_app_cpu_tenant_total"
  ],
  "querytype": "list",
  "since": 1646157317
}

Response

Sucessfully fetched metrics details.

codeinteger

HTTP response code.

errorboolean

Flag if there is an error in response. False for this response.

resultstring

Returns metrics details.

Example response

{
  "code": 200,
  "result": "{\"c8cep_app_cpu_tenant_total\":[]}"
}

Changes

No recorded changes to this operation across all 1 revision of this API.