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

Exporting Access Statistics of Application Streaming

Function

Creates a task of exporting access statistics of Application Streaming. Only data of the last 30 days can be exported. After the task is created, call the ListExportTasks API to query the task status by task ID and call the DownloadExportFile API to download the exported file.

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:exportAppUserAccessData

    Write

    -

    -

    -

    -

URI

POST /v2/{project_id}/statistics/metrics/app-user-access/export

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID.

Request Parameters

Table 2 Request body 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.

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

{
  "start_time" : "2022-05-11T11:45:42Z",
  "end_time" : "2022-05-11T11:45:42Z",
  "username" : "xxx",
  "sort_field" : "access_failed_count",
  "sort_type" : "DESC"
}

Example Responses

Status code: 200

Succeeded.

{
  "task_id" : "2b31ed520xxxxxxebedb6e57xxxxxxxx"
}

Status Codes

Status Code

Description

200

Succeeded.

400

Invalid request from the client.

401

Authentication failed.

500

Internal error.

Error Codes

See Error Codes.

Parent topic: Report Statistics