API overview - Quick BI - Alibaba Cloud Documentation Center

API standard and pre-built SDKs in multi-language

The OpenAPI specification of this product (quickbi-public/2022-01-01) follows the RPC standard. Alibaba Cloud provides pre-built SDKs for popular programming languages to abstract low-level complexities such as request signing. This enables developers to call APIs using language-specific syntax without dealing with HTTP details directly.

Custom signature

If your specific needs, such as a customized signature, are not supported by the SDK, manually sign requests using the signature mechanism. Note that manual signing requires significant effort (usually about 5 business days). For support, join our DingTalk group (ID: 147535001692).

Before you begin

An Alibaba Cloud account has full administrative privileges. A compromised AccessKey pair exposes all associated resources to unauthorized access, posing a significant security risk. Create a Resource Access Management (RAM) user with API-only access and use RAM policies to apply the principle of least privilege (PoLP). Alibaba Cloud accounts are only used when explicitly required.

To call APIs securely, configure the following:

A RAM user account
An AccessKey pair for the account

Organization Management

API	Title	Description
Organization User Management	Organization User Management
CheckOrganizationMember	CheckOrganizationMember	Checks if a user is a member of an organization.
CreateCubeBySql	CreateCubeBySql	Creates a dataset from a custom SQL statement.
BatchAddFeishuUsers	Batch Add Feishu Users	Batch add Feishu users.
QueryUserInfoByAccount	QueryUserInfoByAccount	Queries user information based on the Alibaba Cloud ID or Alibaba Cloud account name.
Role Management	Role Management
ListWorkspaceUserRolesByUserId	ListWorkspaceUserRolesByUserId	Queries all workspace roles of a user.
ListOrganizationRoles	Get Organization Role List	Retrieve the list of custom roles at the organization level.

Permission Management

API	Title	Description
DataPortal Menu Authorization Management	DataPortal Menu Authorization Management
ListPortalMenuAuthorization	ListPortalMenuAuthorization	Retrieves a list of authorization details for the menus in a BI portal.
Row-Level Permission Management	Row-Level Permission Management
SetDataLevelPermissionRuleConfig	Set Single Dataset Row and Column Permission Configuration Information	Set single dataset row and column permission configuration information (addition and update)
AddDataLevelPermissionRuleUsers	AddDataLevelPermissionRuleUsers	Adds specified users and user groups to a row-level permission rule.
AddDataLevelPermissionWhiteList	AddDataLevelPermissionWhiteList	Modifies the whitelist for row-level and column-level permissions of a specified dataset.
DeleteDataLevelRuleConfig	DeleteDataLevelRuleConfig	Deletes a row-level permission rule.
DeleteDataLevelPermissionRuleUsers	DeleteDataLevelPermissionRuleUsers	Deletes specified users from a row-level permission rule.
UpdateDataLevelPermissionStatus	UpdateDataLevelPermissionStatus	Updates the row-level and column-level permission status for a dataset.
SetDataLevelPermissionExtraConfig	SetDataLevelPermissionExtraConfig	Set extra configuration for row and column permissions.
QueryDatasetSwitchInfo	QueryDatasetSwitchInfo	Get the row-level permission switch status for a specified dataset.

Resource Management

API	Title	Description
Report Resource Management	Report Resource Management
UpdateEmbeddedStatus	UpdateEmbeddedStatus	Change the embedding status of a report, turn on embedding, or turn off embedding.
QueryWorksByOrganization	Query All Works Under the Organization	Query all works under the entire organization, with the option to specify the type of work.
QueryReadableResourcesListByUserIdV2	Query List of Works User Has Permission to View (New)	Query list of works user has permission to view (new)
Dataset Resource Management	Dataset Resource Management
CheckDatasetExisted	CheckDatasetExisted	Checks whether a dataset with the specified CubeId exists.
CreateDataset	CreateDataset	Creates a dataset from a physical table.
AddDataSource	AddDataSource	Adds the connection information for a data source.
UpdateDataSource	UpdateDataSource	Modify Data Source Configuration
UpdateCubeBySql	UpdateCubeBySql	Updates a dataset that is based on a custom SQL statement.
QueryLastAccelerationEngineJob	QueryLastAccelerationEngineJob	Query the Most Recent Acceleration Task by Dataset ID
QueryDatasetInfo	QueryDatasetInfo	Indicates whether the table is a custom SQL table. Valid values: \\* true: custom SQL table \\* false: non-custom SQL table
QueryDatasetList	QueryDatasetList	Queries the datasets in a specified workspace. The results are sorted in descending order by creation time.
ListAccelerationOfWorkspace	ListAccelerationOfWorkspace	Retrieves information about acceleration tasks in a workspace.
QueryAccelerationLogByCubeId	QueryAccelerationLogByCubeId	Queries the run logs of acceleration tasks for a specified dataset.
Workspace Management	Workspace Management
CreateWorkspace	CreateWorkspace	Creates a workspace.
Collection Management	Collection Management
ListCollections	ListCollections	Retrieve the list of works that a user has favorited.

Data Management

API	Title	Description
Data Service	Data Service
QueryData	QueryData	Calls an API that was created in DataService Studio.
QueryDataService	Invoke Data Service API	Invoke an already created API in the data service.

Statistical Analysis

API	Title	Description
Resource Analysis	Resource Analysis
QueryAuditLog	Query Audit Log Information	Queries audit log information.

SmartQ

API	Title	Description
SmartQ Management	SmartQ Management
ModifyDashboardNl2sqlStatus	ModifyDashboardNl2sqlStatus	Modifies the Q-Assistant status for multiple dashboards.
QueryDashboardNl2sql	QueryDashboardNl2sql	Query Dashboard's Question Resource Information
SmartqAuthorize	Batch Management of Smart Q\\\\\\&A Authorizations	Batch Management of Smart Q\\\\\\&A Authorizations
QueryLlmCubeWithThemeListByUserId	Check which datasets and analysis themes the user has question authorization for	Check which datasets and analysis themes the user has question authorization for
QueryDatasetSmartqStatus	Check if the Dataset has Enabled Smart Query	Check if the Dataset has Enabled Smart Query
SmartqQueryAbility	Smart Query	Performs an intelligent data query.

Others

API	Title	Description
AddShareReport	Add data work sharing configuration	Add a sharing configuration for data works.
AddUser	Add Organization Member	Add an organization member.
AddUserGroupMember	AddUserGroupMember	Adds an organization member to a specified user group.
AddUserGroupMembers	AddUserGroupMembers	Add users to a specified user group at a time.
AddUserTagMeta	Add Organization Member Tag Metadata	Add organization member tag metadata.
AddUserToWorkspace	Add Member to Workspace	Add a member to the specified workspace.
AddWorkspaceUsers	Batch Add Members to Workspace	Batch add members to the workspace.
AllotDatasetAccelerationTask	AllotDatasetAccelerationTask	Trigger the collection acceleration of the Quick engine for datasets.
AuthorizeMenu	AuthorizeMenu	Batch authorization of BI portal menu will be skipped automatically.
CancelAuthorizationMenu	Batch Cancel Data Portal Menu Authorization	Cancel the authorization records for specified users and user groups based on the portal menu ID.
CancelCollection	CancelCollection	Cancel the data works from the user's collection.
CancelReportShare	CancelReportShare	Delete a share authorization for a data work.
ChangeVisibilityModel	ChangeVisibilityModel	Modifies the visibility mode of the BI portal menu and whether the menu is only authorized to be visible.
CheckReadable	CheckReadable	Queries whether a user has permissions to view data works, such as dashboards and workbooks.
CreateTicket	Generate Report Embedding Ticket	Generate a ticket for third-party embedding.
CreateTicket4Copilot	Generate Smart Q Embedding Ticket	Generate an embedding ticket for Smart Q.
CreateUserGroup	CreateUserGroup	Create a user group. You can specify a parent user group.
DataSetBlood	DataSetBlood	Query works information under the specified dataset.
DataSourceBlood	Query dataset information under the specified data source	Query dataset information under the specified data source
DelayTicketExpireTime	DelayTicketExpireTime	Update the expiration time of the ticket embedded in the report.
DeleteTicket	Delete Embedded Ticket	Delete Third-Party Embedded Ticket
DeleteUser	Delete Organization User	Delete the specified organization user.
DeleteUserFromWorkspace	Remove Workspace Member	Delete a member from the specified workspace.
DeleteUserGroup	DeleteUserGroup	Deletes a user group in an organization.
DeleteUserGroupMember	DeleteUserGroupMember	Deletes a specified member from a specified user group.
DeleteUserGroupMembers	DeleteUserGroupMembers	Batch remove specified users from user groups.
DeleteUserTagMeta	DeleteUserTagMeta	Deletes the tag metadata of an organization member.
GetDataSourceConnectionInfo	GetDataSourceConnectionInfo	Get Data Source Information
GetMailTaskStatus	GetMailTaskStatus	Check the running status of mail tasks within an organization
GetUserGroupInfo	Get User Group Information by Keyword	Search for user group information based on the keyword of the user group name.
GetWorksEmbedList	Get Embedded Reports	Query the list of embedded reports
ListApiDatasource	ListApiDatasource	Queries API data sources.
ListByUserGroupId	ListByUserGroupId	Queries user group information at a time by user group ID.
ListCubeDataLevelPermissionConfig	ListCubeDataLevelPermissionConfig	You can this operation to obtain a list of row and column permission configurations for a specified dataset.
ListDataLevelPermissionWhiteList	Get Dataset Row and Column Permission Whitelist	Retrieve the whitelist for dataset row and column permissions based on the type of permission.
ListDataSource	ListDataSource	Query all data sources under the specified space
ListFavoriteReports	Favorite Reports List on Home Dashboard	Overview
ListOrganizationRoleUsers	ListOrganizationRoleUsers	Get user list under the specified organization role.
ListPortalMenus	ListPortalMenus	Gets a hierarchical list of menus under a specific BI portal.
ListRecentViewReports	ListRecentViewReports	You can call this operation to obtain a list of the most frequently viewed and footsteps displayed in the homepage dashboard for a specified user.
ListSharedReports	ListSharedReports	You can this operation to obtain the list of authorized works displayed on the homepage of a specified user.
ListUserGroupsByUserId	ListUserGroupsByUserId	Queries all user groups to which a user belongs based on the user ID.
ListWhitePortalMenu	ListWhitePortalMenu	Retrieves the whitelist for a BI portal menu.
ListWorkspaceRoleUsers	ListWorkspaceRoleUsers	Get user list under the specified workspace role.
ListWorkspaceRoles	ListWorkspaceRoles	Get the list of workspace roles.
ManualRunMailTask	ManualRunMailTask	Manually Execute Email Task
ModifyApiDatasourceParameters	ModifyApiDatasourceParameters	Modifies the configurations of a specified API data source.
ModifyCopilotEmbedConfig	Modify Intelligent Query Embedding Configuration	Modify Intelligent Query Embedding Configuration
QueryApprovalInfo	QueryApprovalInfo	Get approval flow information based on the approver.
QueryComponentPerformance	QueryComponentPerformance	Queries component performance logs.
QueryCopilotEmbedConfig	Get the List of Configurations for Activating XiaoQ Embedding	Get the List of Configurations for Activating XiaoQ Embedding
QueryCubeOptimization	QueryCubeOptimization	Queries dataset optimization suggestions.
QueryCubePerformance	QueryCubePerformance	Queries the performance logs of a dataset.
QueryDataRange	Get Data Range Catalog List	Get Data Range Catalog List
QueryDataServiceList	QueryDataServiceList	Query Data Service API List
QueryDatasetDetailInfo	QueryDatasetDetailInfo	Queries the details of a specified dataset, including the data source, directory, and dataset model.
QueryEmbeddedInfo	QueryEmbeddedInfo	Obtain the embedding configuration in the organization, including the maximum number of embeddings and the number of embeddings.
QueryEmbeddedStatus	QueryEmbeddedStatus	Queries whether embedding is enabled for a report.
QueryOrganizationRoleConfig	QueryOrganizationRoleConfig	Gets the configuration of the specified organization role.
QueryOrganizationWorkspaceList	Get Workspace List Under Organization	Retrieve the list of workspaces under the current organization.
QueryReadableResourcesListByUserId	QueryReadableResourcesListByUserId	Queries the list of works that a user has the permission to view, including the statements that are authorized to share in a space.
QueryReportPerformance	QueryReportPerformance	Queries report performance logs.
QueryShareList	Query the Sharing Records of a Work	Query the list of objects to which a work has been shared, returning only the sharing configurations that are still within their validity period.
QuerySharesToUserList	QuerySharesToUserList	You can call this operation to query the list of works authorized to a user.
QuerySmartqPermissionByCubeId	Check if a user has permission for a specific smart question dataset	Check if a user has permission for a specific smart question dataset
QueryTicketInfo	QueryTicketInfo	Obtains the details of a specified ticket for a report that is not embedded in the report.
QueryUserGroupListByParentId	QueryUserGroupListByParentId	You can this operation to obtain information about child user groups under a specified parent user group.
QueryUserGroupMember	Query User Group Member List	Retrieve the list of members under a user group.
QueryUserInfoByUserId	QueryUserInfoByUserId	Queries user information based on the user ID.
QueryUserList	QueryUserList	Queries the members of an organization.
QueryUserRoleInfoInWorkspace	Query Preset Roles of Workspace Members	Get the preset workspace role information for a specified workspace member.
QueryUserTagMetaList	QueryUserTagMetaList	Queries the metadata list of member tags in an organization.
QueryUserTagValueList	QueryUserTagValueList	Query the list of specific user tag values.
QueryWorks	QueryWorks	Queries information about a specified data work.
QueryWorksBloodRelationship	QueryWorksBloodRelationship	Obtains the kinship of a data work, including the datasets referenced by each component and query field information. Currently, only supported data works include dashboards, workbooks, and self-service data retrieval.
QueryWorksByWorkspace	QueryWorksByWorkspace	Queries all works in a workspace under an organization. You can specify the type of work.
QueryWorkspaceRoleConfig	QueryWorkspaceRoleConfig	Get Configuration Information for a Specified Workspace Role
QueryWorkspaceUserList	List Members Under a Workspace	Query the list of members under a specified workspace.
ResultCallback	ResultCallback	You can customize the callback interface for approval processes to process Quick BI approval processes.
SaveFavorites	Add Work to Favorites	Add a user's favorite work
SetDataLevelPermissionWhiteList	SetDataLevelPermissionWhiteList	Sets the whitelist for the specified row-level permissions.
SmartqAuthTransfer	Synchronize the question count permissions of a specified user to other users	Synchronize the question count permissions of a specified user to other users
UpdateTicketNum	UpdateTicketNum	Update the ticket quantity on the specified ticket used for the exemption embedded report.
UpdateUser	UpdateUser	Updates the information of a specified member in an organization.
UpdateUserGroup	UpdateUserGroup	Updates information about a specified user group in an organization.
UpdateUserTagMeta	UpdateUserTagMeta	Used for updating the metadata of organization member tags
UpdateUserTagValue	Update Organization Member Tag Value	Update the tag value of an organization member.
UpdateWorkspaceUserRole	Modify Workspace Member Role	Modify the role of a specified member under the workspace, existing roles will be overwritten.
UpdateWorkspaceUsersRole	Batch Update Workspace Member Roles	Batch update the role information of workspace members, existing roles will be overwritten
WithdrawAllUserGroups	WithdrawAllUserGroups	Make the user exit all user groups. This process is irreversible. Exercise caution when performing this operation.