GET /tenant-management/api/admin/metrics

Owned by Technische Redaktion
Last updated: Jun 16, 2022
1 min read
As of Version

2020 Winter

Request MethodGET
Response FormatJSON
Description

Retrieves the current metrics of the tenant. 

The data are retrieved from the METRICS service. This service evaluates the current status of the system usage and caches the result for 30 seconds. After this time, a new evaluation is executed and the new results replace the previous ones in the cache.

Required user role: YUUVIS_TENANT_ADMIN

The metrics parameters are:

  • analysisTime: datetime of the call
  • totalObjectCount: the count of existing object instances (current versions only)
  • totalUsedDiskSpace: the used storage space for document files (attached to current object versions) in bytes

Meaning of the response status codes:

HTTP Status CodeMeaning
200 OKSuccessful, the data of all users of the specified tenant have been read.
401 UNAUTHORIZEDThe call was unauthorized.
Request Example

GET /tenant-management/api/admin/metrics HTTP/1.1

Response Example
response body
{
  "analysisTime": "2021-10-05T13:22:44.222+0000",
  "totalObjectCount": 70,
  "totalUsedDiskSpace": 336180491
}
{