ListFavoriteReports API for listing a user's favorite reports - Quick BI - Alibaba Cloud - Quick BI

Retrieves the list of favorited works 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:ListFavoriteReports

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
UserId	string	Yes	The Quick BI user ID to query.	b5d8fd9348cc4327****afb604
Keyword	string	No	Keyword to filter by work name.	财务报表
TreeType	string	No	Work type to query. Leave blank to query all types. Valid values: DATAPRODUCT: Data Portal PAGE: Dashboard REPORT: Spreadsheet	PAGE
PageSize	integer	No	Number of rows per page. Default value: 10. Maximum value: 9999.	10

Response elements

Element	Type	Description	Example
	object
RequestId	string	Request ID.	D787E1A3-A93C-424A-B626-C2B05DF8D885
Result	object	The query result.
Data	array<object>	The list of queried works.
	object
Favorite	boolean	Whether the user has favorited the work.	true
FavoriteDate	string	Timestamp when the work was favorited.	1640088615000
GmtCreate	string	Timestamp when the work was created.	1640088615000
GmtModified	string	Timestamp when the work was last modified.	1640595729000
HasEditAuth	boolean	Whether the user has edit permission on the work.	true
HasViewAuth	boolean	Whether the user has view permission on the work.	true
Name	string	Name of the work.	测试报表
OwnerName	string	Alibaba Cloud account name of the work owner.	luyaotest的昵称非管理员
OwnerNum	string	User ID of the work owner.	1365*****238860
PublishStatus	integer	Publication status of the work. Valid values: 0: Not published 1: Published 2: Saved with modifications, not published 3: Offline	1
TreeId	string	Work ID.	977c7698-**--**-44b7304d20fc
Type	string	Type of the work. Valid values: DATAPRODUCT: Data Portal PAGE: Dashboard REPORT: Spreadsheet	PAGE
WorkspaceId	string	ID of the workspace that the work belongs to.	523793cb-**--**-aa71c65ffa39
WorkspaceName	string	Name of the workspace that the work belongs to.	测试工作空间
PageNum	integer	Page number.	1
PageSize	integer	Number of rows per page.	10
TotalNum	integer	Total number of rows.	1
TotalPages	integer	Total number of pages.	1
Success	boolean	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": {
    "Data": [
      {
        "Favorite": true,
        "FavoriteDate": "1640088615000",
        "GmtCreate": "1640088615000",
        "GmtModified": "1640595729000",
        "HasEditAuth": true,
        "HasViewAuth": true,
        "Name": "测试报表",
        "OwnerName": "luyaotest的昵称非管理员",
        "OwnerNum": "1365*****238860",
        "PublishStatus": 1,
        "TreeId": "977c7698-****-****-****-44b7304d20fc",
        "Type": "PAGE",
        "WorkspaceId": "523793cb-****-****-****-aa71c65ffa39",
        "WorkspaceName": "测试工作空间"
      }
    ],
    "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.