Help Center/ Workspace/ API Reference/ Workspace APIs/ Report Statistics/ Exporting User Usage Statistics
Updated on 2026-02-10 GMT+08:00
View PDF
Share

Exporting User Usage Statistics

Function

Exports user usage statistics.

Data within a maximum of 30 days can be exported.

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, no identity policy-based permission required for calling this API.

URI

GET /v3/{project_id}/statistics/metrics/users/export

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.

Request Parameters

None

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

task_id

String

Export task ID.

Status code: 400

Table 4 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 401

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 500

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Example Requests

None

Example Responses

None

Status Codes

Status Code

Description

200

ID of the export task.

400

Invalid request from the client.

401

Authentication failed.

500

Internal error.

Error Codes

See Error Codes.

Parent topic: Report Statistics