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

Deprecated as of 2023 Autumn!

This endpoint is not part of yuuvis® Momentum anymore and will be removed with product version 2023 Winter. Please use GET /api/system/tenants/{tenant}/metrics/{metric} instead.

As of Version

product version 2021 Summer | component version 1.1

Request MethodGET
Response FormatJSON
Required Permission

Available if listed in authorization.accesses in authentication-prod.yml and the specified access condition is matched. In the default configuration, access is granted via the YUUVIS_SYSTEM_INTEGRATOR role.

>> AUTHENTICATION Service
Description

Retrieves the current metrics of the specified tenant. The metrics parameters are:

ParameterDescription
analysisTimedatetime of the call
totalFolderCount (as of 2022 Autumn)the count of existing folder object instances
totalObjectCountthe count of existing object instances
totalUsedDiskSpacethe 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/system/tenants/myTenant/metrics HTTP/1.1

Response Example

{

{
  "analysisTime": "2021-03-11T15:48:01.546+0000",
  "totalFolderCount": 159,
  "totalObjectCount:" 1080,
  "totalUsedDiskSpace": 6129337139
}