GET /tenant-management/api/system/tenants/{tenant}/metrics

Owned by Technische Redaktion
Oct 05, 2021
As of Version

2020 Winter

Request MethodGET
Response FormatJSON
Description

Retrieves the current metrics of the specified tenant. 

Required user role: YUUVIS_SYSTEM_INTEGRATOR

The metrics parameters are:

  • analysisTime: datetime of the call
  • totalObjectCount: the count of existing object instances
  • totalUsedDiskSpace: the used storage space for document files in bits

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/system/tenants/myTenant/metrics HTTP/1.1

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