Help Center/ Workspace/ API Reference/ Workspace APIs/ Report Statistics/ Querying Access Statistics of Application Streaming

Updated on 2025-07-14 GMT+08:00

View PDF

Querying Access Statistics of Application Streaming

Function

Query statistics about Application Streaming access. You can query data of a maximum of 30 days at a time, and data of the past 30 days.

Debugging

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

URI

GET /v2/{project_id}/statistics/metrics/app-user-access

**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 (UTC), for example, 2022-05-11T11:45:42Z. "
end_time	Yes	String	Query end time (UTC), for example, 2022-05-11T11:45:42Z. "
username	No	String	Username (fuzzy match).
sort_field	No	String	Sorting by metric. access_failed_count: by the number of access failures last_access_failed_time: by the latest access failure time
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

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	No	String	User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

Response Parameters

Status code: 200

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

**Table 5** AppUserAccessData
Parameter	Type	Description
username	String	Username.
access_failed_count	Integer	Number of access failures.
last_access_failed_time	String	Time when the last access fails. The value is in UTC format, for example, 2022-05-11T11:45:42Z.
error_code	String	Error code.
error_msg	String	Error message.

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",
    "access_failed_count" : 3,
    "last_access_failed_time" : "2022-05-11T11:45:42Z",
    "error_code" : "WKS.xxx",
    "error_msg" : "login failed."
  } ]
}