本產品（
Quick BI/2022-01-01）的OpenAPI采用RPC簽名風格，簽名細節參見簽名機制說明。我們已經為開發者封裝了常見編程語言的SDK，開發者可通過下載SDK直接調用本產品OpenAPI而無需關心技術細節。如果現有SDK不能滿足使用需求，可通過簽名機制進行自簽名對接。由于自簽名細節非常復雜，需花費 5個工作日左右。因此建議加入我們的服務釘釘群（78410016550），在專家指導下進行簽名對接。在使用API前，您需要準備好身份賬號及訪問密鑰（AccessKey），才能有效通過客戶端工具（SDK、CLI等）訪問API。細節請參見獲取AccessKey。
組織管理
| API | 標題 | API概述 |
|---|---|---|
| 組織用戶管理 | 組織用戶管理 | |
| AddUser | 添加組織成員 | 添加組織成員。 |
| BatchAddFeishuUsers | 批量添加飛書用戶 | 批量添加飛書用戶。 |
| DeleteUser | 刪除組織用戶 | 刪除指定組織用戶。 |
| UpdateUser | 更新組織成員信息 | 更新組織下指定成員的信息。 |
| QueryUserList | 查詢組織成員列表信息 | 查詢組織成員列表信息。 |
| QueryUserInfoByUserId | 根據用戶ID查詢用戶信息 | 根據用戶ID查詢用戶信息。 |
| QueryUserInfoByAccount | 根據賬號查詢用戶信息 | 根據阿里云ID或阿里云賬戶名查詢用戶信息。 |
| 組織用戶組管理 | 組織用戶組管理 | |
| CreateUserGroup | 新建用戶組 | 新建用戶組，可以指定父用戶組。 |
| AddUserGroupMember | 添加成員到用戶組 | 將組織成員添加到指定的用戶組。 |
| AddUserGroupMembers | 批量添加成員到用戶組 | 將用戶批量添加到指定的用戶組中。 |
| DeleteUserGroup | 刪除用戶組 | 刪除組織內的用戶組。 |
| DeleteUserGroupMember | 刪除用戶組成員 | 刪除指定用戶組下的指定成員。 |
| DeleteUserGroupMembers | 用戶批量退出用戶組 | 指定用戶批量退出用戶組。 |
| WithdrawAllUserGroups | 用戶退出所有用戶組 | 使用戶退出所有用戶組，該過程不可逆，請謹慎操作。 |
| UpdateUserGroup | 更新用戶組信息 | 更新組織下指定用戶組的信息。 |
| GetUserGroupInfo | 根據關鍵字獲取用戶組信息 | 根據用戶組名稱關鍵字搜索用戶組信息。 |
| ListByUserGroupId | 批量查詢用戶組 | 根據用戶組ID批量查詢用戶組信息。 |
| ListUserGroupsByUserId | 查詢用戶所屬的用戶組信息列表 | 根據用戶的UserID，查詢該用戶所屬的所有用戶組信息。 |
| QueryUserGroupListByParentId | 查詢父用戶組下的子用戶組列表 | 獲取指定父用戶組下的子用戶組信息。 |
| QueryUserGroupMember | 查詢用戶組成員列表 | 獲取用戶組下的成員列表信息。 |
| 用戶標簽管理 | 用戶標簽管理 | |
| AddUserTagMeta | 新增組織成員標簽元信息 | 新增組織成員標簽元信息。 |
| DeleteUserTagMeta | 刪除組織成員標簽元信息 | 刪除組織成員的標簽元信息。 |
| UpdateUserTagValue | 更新組織成員標簽值 | 更新組織成員標簽值。 |
| QueryUserTagMetaList | 查詢組織成員標簽元信息列表 | 查詢組織內成員標簽元信息列表。 |
| QueryUserTagValueList | 查詢組織成員標簽值列表 | 查詢特定用戶標簽值列表。 |
| UpdateUserTagMeta | 更新組織成員標簽元信息 | 用于更新組織成員標簽元信息。 |
| 角色管理 | 角色管理 | |
| ListWorkspaceRoleUsers | 獲取指定空間角色下的用戶列表 | 獲取指定空間角色下的用戶列表。 |
| QueryWorkspaceRoleConfig | 獲取指定空間角色的配置信息 | 獲取指定空間角色的配置。 |
| QueryOrganizationRoleConfig | 獲取指定組織角色的配置信息 | 獲取指定組織角色的配置。 |
| ListWorkspaceRoles | 獲取空間角色列表 | 獲取空間角色列表。 |
| ListOrganizationRoles | 獲取組織角色列表 | 獲取組織角色列表。 |
| ListOrganizationRoleUsers | 獲取指定組織角色下的用戶列表 | 獲取指定組織角色下的用戶列表。 |
權限管理
| API | 標題 | API概述 |
|---|---|---|
| 報表分享授權管理 | 報表分享授權管理 | |
| AddShareReport | 添加數據作品分享配置 | 添加數據作品的一個分享配置。 |
| CancelReportShare | 刪除數據作品的分享授權 | 刪除數據作品的一個分享授權。 |
| QuerySharesToUserList | 查詢授權給用戶的作品列表 | 查詢授權給用戶的作品列表。 |
| QueryShareList | 查詢作品的分享記錄 | 查詢作品被分享給哪些對象的列表，只返回仍然在有效期限內的分享配置。 |
| 數據門戶菜單授權管理 | 數據門戶菜單授權管理 | |
| AuthorizeMenu | 數據門戶菜單批量授權 | 數據門戶菜單的批量授權，已經授權的會自動略過。 |
| CancelAuthorizationMenu | 批量取消數據門戶菜單授權 | 根據門戶菜單ID，取消指定用戶、用戶組的授權記錄。 |
| ChangeVisibilityModel | 修改數據門戶菜單的可見方式 | 修改數據門戶菜單的可見方式，是否僅授權可見。 |
| ListPortalMenus | 獲取數據門戶菜單列表 | 獲取具體數據門戶下的分層菜單列表。 |
| ListPortalMenuAuthorization | 獲取數據門戶菜單的授權詳情 | 獲取數據門戶菜單的授權詳情列表。 |
| 行級權限管理 | 行級權限管理 | |
| SetDataLevelPermissionRuleConfig | 設置單條數據集行列權限配置信息 | 設置單條數據集行列權限配置信息（新增和更新）。 |
| AddDataLevelPermissionRuleUsers | 添加行列權限規則人群 | 針對單條行列權限規則增量添加選定的人群。 |
| AddDataLevelPermissionWhiteList | 增量修改行列權限白名單 | 修改指定數據集行列權限的白名單。 |
| DeleteDataLevelRuleConfig | 刪除行列權限規則 | 刪除單條行列權限規則。 |
| DeleteDataLevelPermissionRuleUsers | 刪除行列規則的人群 | 針對單條行列權限規則刪除選定的人群。 |
| UpdateDataLevelPermissionStatus | 更新數據集行列權限開關狀態 | 更新數據集行列權限開關狀態。 |
| SetDataLevelPermissionExtraConfig | 設置行列權限額外配置 | 設置行列權限的額外配置。 |
| SetDataLevelPermissionWhiteList | 設置行級權限白名單 | 設置指定行級權限的白名單列表。 |
| QueryDatasetSwitchInfo | 獲取數據集行級權限開關狀態 | 獲取指定數據集的行級權限開關狀態。 |
| ListCubeDataLevelPermissionConfig | 獲取數據集行列權限配置列表 | 獲取指定數據集的行列權限配置列表。 |
| ListDataLevelPermissionWhiteList | 獲取數據集行列權限白名單列表 | 根據行列權限種類，獲取數據集行列權限的白名單列表。 |
| 開放審批 | 開放審批 | |
| QueryApprovalInfo | 根據審批人獲取相應的審批流信息 | 根據審批人獲取相應的審批流信息。 |
| ResultCallback | 自定義審批流回調接口 | 自定義審批流回調接口，用戶自行對Quick BI的審批流進行處理。 |
資源管理
| API | 標題 | API概述 |
|---|---|---|
| 報表資源管理 | 報表資源管理 | |
| UpdateEmbeddedStatus | 更改報表的嵌入狀態 | 更改報表的嵌入狀態，開通嵌入、或者關閉嵌入。 |
| QueryWorksByOrganization | 查詢組織下的所有作品 | 查詢整個組織下的所有作品，可指定作品類型。 |
| QueryWorksByWorkspace | 查詢工作空間下的所有作品 | 查詢組織下某個工作空間下的所有作品，可指定作品類型。 |
| QueryReadableResourcesListByUserId | 查詢用戶有權查看的作品列表 | 查詢用戶有權查看的作品列表，包含空間下與分享授權的報表。 |
| CheckReadable | 查詢用戶對數據作品的查看權限 | 查詢用戶對數據作品（儀表板、電子表格等）是否有權限查看。 |
| QueryEmbeddedInfo | 獲取組織嵌入配置 | 獲取組織下的嵌入配置，包括最大嵌入數和已經嵌入數等。 |
| QueryEmbeddedStatus | 查詢報表嵌入狀態 | 查詢某個報表是否已經開通嵌入。 |
| QueryWorks | 查詢數據作品信息 | 查詢指定數據作品信息。 |
| QueryWorksBloodRelationship | 查詢數據作品的血緣信息 | 獲取數據作品的血緣關系，包括各組件引用的數據集以及查詢字段信息。目前僅支持的數據作品包含儀表板、電子表格、自助取數。 |
| QueryComponentPerformance | 查詢組件性能日志 | 查詢組件性能日志。 |
| QueryReportPerformance | 查詢報表性能日志 | 查詢報表性能日志。 |
| GetWorksEmbedList | 獲取已經嵌入的報表 | 查詢已嵌入報表列表。 |
| 數據集資源管理 | 數據集資源管理 | |
| DataSetBlood | 查詢引用指定數據集下的作品信息 | 查詢引用指定數據集下的作品信息。 |
| DataSourceBlood | 查詢引用指定數據源下的數據集信息 | 查詢引用指定數據源下的數據集信息。 |
| ModifyApiDatasourceParameters | 修改API數據源配置 | 修改指定API數據源的配置。 |
| ListApiDatasource | 查詢API數據源列表 | 查詢API數據源列表。 |
| QueryDatasetInfo | 查詢數據集信息 | 查詢指定數據集的信息。 |
| QueryDatasetDetailInfo | 查詢數據集詳情 | 查詢指定數據集的詳情，包括所屬數據源、目錄、以及數據集模型。 |
| QueryDatasetList | 查詢工作空間數據集列表 | 查詢指定工作空間的數據集列表，按照創建時間倒序排列。 |
| AllotDatasetAccelerationTask | 觸發數據集抽取加速 | 觸發數據集Quick引擎的采集加速。 |
| QueryCubePerformance | 查詢數據集性能日志 | 查詢數據集性能日志。 |
| QueryCubeOptimization | 查詢數據集優化建議 | 查詢數據集優化建議。 |
| 工作空間管理 | 工作空間管理 | |
| AddUserToWorkspace | 添加成員到工作空間 | 添加成員到指定工作空間。 |
| AddWorkspaceUsers | 批量添加成員到工作空間 | 批量添加成員到工作空間。 |
| DeleteUserFromWorkspace | 刪除工作空間成員 | 刪除指定工作空間的成員。 |
| UpdateWorkspaceUsersRole | 批量更新工作空間成員的角色 | 批量更新工作空間成員的角色信息，已有角色會被覆蓋。 |
| UpdateWorkspaceUserRole | 修改工作空間成員角色 | 修改工作空間下指定成員的角色，已有的角色會被覆蓋。 |
| QueryWorkspaceUserList | 查詢工作空間下的成員列表 | 查詢指定工作空間下的成員列表信息。 |
| QueryOrganizationWorkspaceList | 獲取組織下的工作空間列表 | 獲取當前組織下的工作空間列表信息。 |
| QueryUserRoleInfoInWorkspace | 查詢工作空間成員的預置角色 | 獲取指定工作空間成員的預置空間角色信息。 |
| 收藏管理 | 收藏管理 | |
| SaveFavorites | 添加作品收藏 | 添加用戶的收藏數據作品。 |
| CancelCollection | 取消作品收藏 | 取消用戶收藏的數據作品。 |
| ListCollections | 獲取用戶收藏作品列表 | 獲取用戶收藏的作品列表。 |
| 首頁管理 | 首頁管理 | |
| ListFavoriteReports | 首頁看板收藏列表 | 獲取指定用戶在首頁看板中展示的收藏作品列表。 |
| ListRecentViewReports | 獲取首頁看板常看和足跡列表 | 獲取指定用戶在首頁看板中展示的常看和足跡列表。 |
| ListSharedReports | 獲取首頁看板被授權的作品列表 | 獲取指定用戶在首頁看板中展示的被授權的作品列表。 |
| 訂閱管理 | 訂閱管理 | |
| ManualRunMailTask | 手動執行郵件任務 | 手動執行訂閱的郵件任務。 |
| GetMailTaskStatus | 查看郵件任務運行狀態 | 查看組織內郵件任務運行狀態（實時狀態非最終狀態）。 |
數據管理
| API | 標題 | API概述 |
|---|---|---|
| 數據服務 | 數據服務 | |
| QueryData | 查詢數據 | 對數據服務中已創建的API進行調用。 |
| QueryDataServiceList | 數據服務列表API | 查詢數據服務API列表。 |
| QueryDataService | 調用數據服務API | 對數據服務中已創建的API進行調用。 |
嵌入分析
| API | 標題 | API概述 |
|---|---|---|
| 報表嵌入 | 報表嵌入 | |
| CreateTicket | 生成報表嵌入ticket | 生成報表嵌入需要使用的ticket。 |
| DeleteTicket | 刪除嵌入ticket | 刪除免登嵌入報表的指定ticket。 |
| DelayTicketExpireTime | 更新嵌入ticket的失效時間 | 更新嵌入報表的ticket的失效時間。 |
| UpdateTicketNum | 更新嵌入ticket票據數量 | 對用于免登嵌入報表的指定的ticket進行更新票據數量操作。 |
| QueryTicketInfo | 查詢嵌入報表ticket詳情 | 獲取免登嵌入報表的指定ticket的詳情信息。 |
| 智能問數嵌入 | 智能問數嵌入 | |
| CreateTicket4Copilot | 生成智能小Q嵌入Ticket | 用于生成智能小Q嵌入Ticket。 |
| ModifyCopilotEmbedConfig | 修改智能問數嵌入配置 | 修改智能問數嵌入配置。 |
| QueryCopilotEmbedConfig | 獲取開通小Q嵌入的配置列表 | 獲取開通小Q嵌入的配置列表。 |
| QueryDataRange | 獲取數據范圍目錄列表 | 獲取嵌入配置界面的數據范圍目錄列表。 |
統計分析
| API | 標題 | API概述 |
|---|---|---|
| 資源分析 | 資源分析 | |
| QueryAuditLog | 查詢審計日志信息 | 查詢審計日志信息。 |