列出仪表盘

获取多维表格中的所有仪表盘。

前提条件

调用此接口前，请确保当前调用身份（tenant_access_token 或 user_access_token）已有多维表格的阅读等文档权限，否则接口将返回 HTTP 403 或 400 状态码。了解更多，参考如何为应用或用户开通文档权限。

请求

项目	值
HTTP URL	https://open.feishu.cn/open-apis/bitable/v1/apps/:app_token/dashboards
HTTP Method	GET
接口频率限制	20 次/秒
支持的应用类型	custom,isv
权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用 开启任一权限即可	base:dashboard:read 获取仪表盘信息 bitable:app 查看、评论、编辑和管理多维表格 bitable:app:readonly 查看、评论和导出多维表格

请求头

名称	类型	必填	描述
Authorization	string	是	tenant_access_token 或 user_access_token 值格式："Bearer access_token" 示例值："Bearer u-7f1bcd13fc57d46bac21793a18e560" 了解更多：如何选择与获取 access token

路径参数

名称	类型	描述
app_token	string	多维表格 App 的唯一标识。不同形态的多维表格，其 app_token 的获取方式不同： - 如果多维表格的 URL 以 ==feishu.cn/base== 开头，该多维表格的 app_token 是下图高亮部分： - 如果多维表格的 URL 以 ==feishu.cn/wiki== 开头，你需调用知识库相关获取知识空间节点信息接口获取多维表格的 app_token。当 obj_type 的值为 bitable 时，obj_token 字段的值才是多维表格的 app_token。 了解更多，参考多维表格 app_token 获取方式。 示例值："bascng7vrxcxpig7geggXiCtadY"

查询参数

名称	类型	必填	描述
page_size	int	否	分页大小 示例值：10 数据校验规则： - 最大值：500
page_token	string	否	分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 示例值：blknkqrP3RqUkcAW

响应

响应体

名称	类型	描述
code	int	错误码，非 0 表示失败
msg	string	错误描述
data	\-	-
└ dashboards	app.dashboard\[\]	仪表盘信息
└ block_id	string	仪表盘 ID
└ name	string	仪表盘名称
└ page_token	string	分页标记，当 has_more 为 true 时，会同时返回新的 page_token，否则不返回 page_token
└ has_more	boolean	是否还有更多项

响应体示例

{
    "code": 0,
    "msg": "success",
    "data": {
        "dashboards": [
            {
                "block_id": "blknkqrP3RqUkcAW",
                "name": "仪表盘1"
            }
        ],
        "page_token": "blknkqrP3RqUkcAW",
        "has_more": false
    }
}

错误码

HTTP状态码	错误码	描述	排查建议
400	1254000	WrongRequestJson	请求体错误
400	1254001	WrongRequestBody	请求体错误
400	1254002	Fail	导致报 1254002 错误码的场景较多，请参考以下排查建议排查： - 如果日志内容显示 changeset size exceed the limit, len:xxxxx，表示单次操作的内容变更较大，你需要在单次操作中减少数据量 - 如果日志内容显示 lock not obtained 或 data not ready，表示并发调用接口导致抢锁失败出错。你需控制请求间隔，稍后重试 - 如果在知识库（wiki）中创建多维表格，请检查你是否使用了知识库创建知识空间节点接口创建多维表格。在此场景下不能使用创建多维表格接口 - 请检查接口参数是否有误。例如，在分页查询多维表格时，传递了无效的 page_token，或传递了错误的数据表的 table_id - 如果该报错偶尔发生，可能是服务器超时或不稳定，请重试解决
400	1254003	WrongBaseToken	app_token 错误
400	1254004	WrongTableId	table_id 错误
400	1254005	WrongViewId	view_id 错误
400	1254006	WrongRecordId	检查 record_id
400	1254007	EmptyValue	空值
400	1254008	EmptyView	空视图
400	1254009	WrongFieldId	字段 id 错误
400	1254010	ReqConvError	请求错误
400	1254016	InvalidSort	Sort参数错误
400	1254018	InvalidFilter	filter 参数错误。请参考记录过滤参数填写指南了解如何填写 filter 参数。
400	1254019	InvalidViewType	视图类型无效
400	1254020	ViewNameDuplicated	视图名重复
400	1254021	EmptyViewName	视图名为空
400	1254022	InvalidViewName	视图名无效
400	1254030	TooLargeResponse	响应体过大
400	1254032	InvalidRoleName	自定义角色名无效
400	1254033	RoleNameDuplicated	自定义角色名重复
404	1254040	BaseTokenNotFound	app_token 不存在
404	1254041	TableIdNotFound	table_id 不存在
404	1254042	ViewIdNotFound	view_id 不存在
404	1254043	RecordIdNotFound	record_id 不存在
404	1254044	FieldIdNotFound	field_id 不存在
404	1254045	FieldNameNotFound	字段名称不存在。请检查: - 接口中字段名称和多维表格中的字段名称是否完全匹配。如果难以排查，建议你调用列出字段接口获取字段名称，因为根据表格页面的 UI 名称可能会忽略空格、换行或特殊符号等差异。 - 表格是否开启了高级权限但调用身份缺少对应字段的权限。你需要为调用身份授予高级权限： - 对用户授予高级权限，你需要在多维表格页面右上方 分享 入口为当前用户添加可管理权限。 - 对应用授予高级权限，你需通过多维表格页面右上方 「...」 -> 「...更多」 ->「添加文档应用」 入口为应用添加可管理权限。 注意： 在 添加文档应用 前，你需确保目标应用至少开通了一个多维表格的 API 权限。否则你将无法在文档应用窗口搜索到目标应用。 - 你也可以在 多维表格高级权限设置 中添加用户或一个包含应用的群组, 给予这个群自定义的读写等权限。
404	1254047	RoleIdNotFound	role_id 不存在
400	1254048	MemberNotFound	member 不存在
404	1254049	FormFieldNotFound	form_field_id 不存在
400	1254060	TextFieldConvFail	多行文本字段错误
400	1254061	NumberFieldConvFail	数字字段错误
400	1254062	SingleSelectFieldConvFail	单选字段错误
400	1254063	MultiSelectFieldConvFail	多选字段错误
400	1254064	DatetimeFieldConvFail	日期字段错误
400	1254065	CheckboxFieldConvFail	复选框字段错误
400	1254066	UserFieldConvFail	人员字段有误。原因可能是： - user_id_type 参数指定的 ID 类型与传入的 ID 类型不匹配 - 传入了不识别的类型或结构，目前只支持填写 id 参数，且需要传入数组 - 跨应用传入了 open_id。如果跨应用传入 ID，建议使用 user_id。不同应用获取的 open_id 不能交叉使用
400	1254067	LinkFieldConvFail	关联字段错误
400	1254100	TableExceedLimit	数据表或仪表盘数量超限。每个多维表格中，数据表加仪表盘的数量最多为 100 个
400	1254101	ViewExceedLimit	视图数量超限, 限制200个
400	1254103	RecordExceedLimit	记录数量超限, 限制20,000条
400	1254104	RecordAddOnceExceedLimit	单次添加记录数量超限, 限制500条
400	1254110	RoleExceedLimit	自定义角色数量超限，限制30条
400	1254130	TooLargeCell	格子内容过大
429	1254290	TooManyRequest	请求过快，稍后重试
400	1254291	Write conflict	同一个数据表(table) 不支持并发调用写接口，请检查是否存在并发调用写接口。写接口包括：新增、修改、删除记录；新增、修改、删除字段；修改表单；修改视图等。
400	1254301	OperationTypeError	多维表格未开启高级权限或不支持开启高级权限
403	1254302	Permission denied.	调用身份缺少多维表格的高级权限。你需要为调用身份授予高级权限： - 对用户授予高级权限，你需要在多维表格页面右上方 分享 入口为当前用户添加可管理权限。 - 对应用授予高级权限，你需通过多维表格页面右上方 「...」 -> 「...更多」 ->「添加文档应用」 入口为应用添加可管理权限。 注意： 在 添加文档应用 前，你需确保目标应用至少开通了一个多维表格的 API 权限。否则你将无法在文档应用窗口搜索到目标应用。 - 你也可以在 多维表格高级权限设置 中添加用户或一个包含应用的群组, 给予这个群自定义的读写等权限。
400	1255001	InternalError	内部错误，请联系技术支持
400	1255002	RpcError	内部错误，请联系技术支持
400	1255003	MarshalError	序列化错误，请联系技术支持
400	1255004	UmMarshalError	反序列化错误
400	1255005	ConvError	内部错误，请联系技术支持
504	1255040	请求超时	进行重试
400	1254036	Base is copying, please try again later.	复制多维表格为异步操作，该错误码表示当前多维表格仍在复制中，在复制期间无法操作当前多维表格。需要等待复制完成后再操作
500	1254200	internal error	内部错误，请联系技术支持
400	1254011	The page_size must be between 0 and 100.	page_size参数非法