Get the usage report of users

Use this API to get the usage summary of a domain.

Resource Information

Method

URL

Authentication

GET

/V1/CMDB/Users/UsageReport

Yes

Parameters

Name

Description

Token*required
(header)

Place the token received from the API Log in to get an authentication token.

tenantId
(query)

Tenant ID.

domainId
(query)

Domain ID.

fromDate
(query)

The start time. If not specified, use the initialization time when the system was installed.
Format: <yyyy>-<mm>-<dd>T<hh>:<mm>:<ss>Z. For example, 2018-03-07T04:59:59Z.

toDate
(query)

The end time. If not specified, use the current time.
Format: <yyyy>-<mm>-<dd>T<hh>:<mm>:<ss>Z. For example, 2018-03-07T04:59:59Z.

Response

Parameter

Type

Description

Example

usageReport

object

The returned usage report. It contains the following parameters:

▪username: the name of a user.

▪ofLogins: the number of logins to the system.

▪lastLogoutTime: the time of the last logout of a user.

▪totalOnlineTime: the total online time of a user.

▪ofLoginFailureDueToSeatLicense: the number of login failures due to seat license.

{
  "statusCode": 790200,
  "statusDescription": "success",
  "usageReport": [
    {
      "username": "NetBrain",
      "ofLogins": "string",
      "firstTimeLogin": "string",
      "lastLogoutTime": "string",
      "totalOnlineTime": "string",
      "ofLoginFailureDueToSeatLicense": "string"
    }
  ]
}

statusCode

integer

The returned status code of executing the API.

statusDescription

string

The explanation of the status code.