Call ListRecentViewReports to get recently and frequently viewed reports - Quick BI - Alibaba Cloud - Quick BI

Retrieves the frequently viewed items and footprint list displayed on the homepage dashboard for a specified user.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

quickbi-public:ListRecentViewReports

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
UserId	string	Yes	The UserID of the user to query in Quick BI.	b5d8fd9348cc4327****afb604
Keyword	string	No	The keyword in the name of the work.	FinancialReport
TreeType	string	No	The type of work to query. Leave this parameter empty to query all types. Valid values: DATAPRODUCT: data portal PAGE: dashboard REPORT: workbook	PAGE
QueryMode	string	No	The query mode. Valid values: 1: Sorted by number of visits. 2: Sorted by most recent visit time.	1
PageSize	integer	No	The number of rows in the work list to query: Default value: 10. Maximum value: 9999.	10
OffsetDay	integer	No	The number of recent days to query data for. Default value: 10.	10

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	D787E1A3-A93C-424A-B626-C2B05DF8D885
Result	object	The query result.
Attention	string	The notice indicating that pagination parameters (such as TotalNum) returned by this API will be deprecated soon.	The pagination parameters such as TotalNum returned by this API will be deprecated soon. If you are using them, modify your code promptly
Data	array<object>	The list of queried works.
	object
Favorite	boolean	Indicates whether the queried user has added the work to favorites.	true
GmtCreate	string	The timestamp when the work was created.	1496651577000
GmtModified	string	The timestamp when the work was last modified.	1640595729000
HasEditAuth	boolean	Indicates whether the queried user has edit permissions on the work.	true
HasViewAuth	boolean	Indicates whether the queried user has view permissions on the work.	true
LatestViewTime	string	The timestamp when the work was last accessed.	1642067498000
Name	string	The name of the work.	TestReport
OwnerName	string	The Alibaba Cloud account name of the work owner.	John
OwnerNum	string	The UserID of the work owner.	1365*****238860
PublishStatus	integer	The publish status of the work. Valid values: 0: Unpublished. 1: Published. 2: Modified and saved but not published. 3: Offline.	1
TreeId	string	The ID of the work.	977c7698-**--**-44b7304d20fc
Type	string	The type of the work. Valid values: DATAPRODUCT: data portal PAGE: dashboard REPORT: workbook	PAGE
ViewCount	integer	The number of times the work has been accessed.	7
WorkspaceId	string	The ID of the workspace to which the work belongs.	523793cb-**--**-aa71c65ffa39
WorkspaceName	string	The name of the workspace to which the work belongs.	TestWorkspace
PageNum	integer	The page number.	1
PageSize	integer	The number of entries per page. Default value: 10. Maximum value: 100.	10
TotalNum	integer	The total number of rows.	1
TotalPages	integer	The total number of pages.	1
Success	boolean	Indicates whether the request was successful. Valid values: true: The request was successful. false: The request failed.	true

Examples

Success response

JSON format

{
  "RequestId": "D787E1A3-A93C-424A-B626-C2B05DF8D885",
  "Result": {
    "Attention": "test",
    "Data": [
      {
        "Favorite": true,
        "GmtCreate": "1496651577000",
        "GmtModified": "1640595729000",
        "HasEditAuth": true,
        "HasViewAuth": true,
        "LatestViewTime": "1642067498000",
        "Name": "Test report\n",
        "OwnerName": "test",
        "OwnerNum": "1365*****238860",
        "PublishStatus": 1,
        "TreeId": "977c7698-****-****-****-44b7304d20fc",
        "Type": "PAGE",
        "ViewCount": 7,
        "WorkspaceId": "523793cb-****-****-****-aa71c65ffa39",
        "WorkspaceName": "Test Workspace\n"
      }
    ],
    "PageNum": 1,
    "PageSize": 10,
    "TotalNum": 1,
    "TotalPages": 1
  },
  "Success": true
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.