Querying User Usage Statistics

Function

Queries user usage statistics.

Data within a maximum of 30 days can be queried.

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.

If you are using identity policy-based authorization, the following identity policy-based permissions are required.

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
workspace:statistics:listUserMetrics	List	-	-	-	-

URI

GET /v2/{project_id}/statistics/metrics/users

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID.

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
start_time	Yes	String	Query start time (GMT).
end_time	Yes	String	Query end time (GMT).
username	No	String	Username (fuzzy match).
usage_min_hours	No	Integer	Minimum usage duration.
usage_max_hours	No	Integer	Maximum usage duration. If both usage_min_hours and usage_max_hours are specified, the value of usage_max_hours must be greater than or equal to that of usage_min_hours.
enterprise_project_id	No	String	Enterprise project ID.
sort_field	No	String	Sorts desktops by metric. user_usage - Sorts desktops by user usage duration.
sort_type	No	String	Direction of sorting by metric. This parameter must be used together with sort_field. DESC - Returns data in descending order. ASC - Returns data in ascending order.
offset	No	Integer	Query offset. The default value is 0.
limit	No	Integer	The value of limit ranges from 1 to 100 and defaults to 10.

Request Parameters

None

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
count	Integer	Total number.
items	Array of UserMetric objects	User metric.

**Table 4** UserMetric
Parameter	Type	Description
username	String	Username.
enterprise_project_id	String	Enterprise project ID.
metric	Array of Metric objects	Desktop usage statistics user_usage - User usage duration (unit: second). If multiple PCs are logged in to at the same time, the usage duration is accumulated. user_login_count - Number of user logins user_login_success_count - Number of successful user logins user_login_fail_count - Number of failed user logins

**Table 5** Metric
Parameter	Type	Description
metric_name	String	Metric name.
metric_value	Double	Metric value.

Status code: 400

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Status code: 401

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Status code: 500

**Table 8** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Example Requests

None

Example Responses

Status code: 200

Succeeded.

{
  "count" : 0,
  "items" : [ {
    "username" : "xxxx",
    "metric" : [ {
      "metric_name" : "desktop_state",
      "metric_value" : 10
    } ]
  } ]
}