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

As of Version

product version 2021 Summer | component version 1.1

Request Method GET

Response Format JSON

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:

Parameter	Description
`analysisTime`	datetime of the call
`totalFolderCount` (as of 2022 Autumn)	the count of existing folder object instances
`totalObjectCount`	the count of existing object instances
`totalUsedDiskSpace`	the used storage space for document files (attached to current object versions) in bytes

Meaning of the response status codes:

HTTP Status Code	Meaning
`200 OK`	Successful, the data of all users of the specified tenant have been read.
`401 UNAUTHORIZED`	The 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
}