GET /tenant-management/api/admin/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_TENANT_ADMIN role.

>> AUTHENTICATION Service

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.

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/admin/metrics HTTP/1.1

Response Example

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