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

Owned by Technische Redaktion
Nov 12, 2021
1 min read
As of Version

product version 2021 Summer | component version 1.1

for non-productive systems: version 2021 Summer RC2

Request MethodGET
Response FormatJSON
Description

Retrieves the current metrics of the specified tenant. 

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

Required user role: YUUVIS_SYSTEM_INTEGRATOR

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
{
  "analysisTime": "2021-03-11T15:48:01.546+0000",
  "totalObjectCount:" 1080,
  "totalUsedDiskSpace": 6129337139
}

{