获取筛选

获取电子表格中工作表的详细筛选信息，包括筛选的应用范围、筛选条件、被筛选条件过滤掉的行。

请求

项目	值
HTTP URL	https://open.feishu.cn/open-apis/sheets/v3/spreadsheets/:spreadsheet_token/sheets/:sheet_id/filter
HTTP Method	GET
接口频率限制	100 次/分钟
支持的应用类型	custom,isv
权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用 开启任一权限即可	drive:drive 查看、评论、编辑和管理云空间中所有文件 drive:drive:readonly 查看、评论和下载云空间中所有文件 sheets:spreadsheet 查看、评论、编辑和管理电子表格 sheets:spreadsheet:readonly 查看、评论和导出电子表格

请求头

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

路径参数

名称	类型	描述
spreadsheet_token	string	电子表格的 token。可通过以下两种方式获取。了解更多，参考电子表格概述。 - 电子表格的 URL：https://sample.feishu.cn/sheets/==Iow7sNNEphp3WbtnbCscPqabcef== - 调用获取文件夹中的文件清单 示例值："Iow7sNNEphp3WbtnbCscPqabcef"
sheet_id	string	工作表 ID，通过获取工作表 获取。 示例值："8fe9d6"

cURL 请求示例

curl --location --request GET 'https://open.feishu.cn/open-apis/sheets/v3/spreadsheets/shtcnSUVpFeJ7QyVN9Gabcef/sheets/6e2914/filter' \
--header 'Authorization: Bearer t-3bf3d4463b8f1956f14240c2517aa8ba2c93d8ec' \
--header 'Content-Type: application/json'

响应

响应体

名称	类型	描述
code	int	错误码，非 0 表示失败
msg	string	错误描述
data	\-	-
└ sheet_filter_info	sheet_filter_info	筛选信息
└ range	string	筛选的应用范围
└ filtered_out_rows	int\[\]	被筛选条件过滤掉的行。从 1 开始索引。
└ filter_infos	filter_info\[\]	工作表的筛选条件
└ col	string	设置了筛选条件的列
└ conditions	condition\[\]	筛选条件
└ filter_type	string	筛选类型，枚举值如下所示。了解更多，参考筛选指南。 - multiValue ：多值筛选 - number ：数字筛选 - text ：文本筛选 - color ：颜色筛选 - clear ：清除筛选
└ compare_type	string	比较类型。不同筛选类型的比较类型的枚举值不同，详情参考筛选指南。
└ expected	string\[\]	筛选参数。不同筛选类型的筛选参数限制不同，详情参考筛选指南。

响应体示例

{
    "code": 0,
    "msg": "success",
    "data": {
        "sheet_filter_info": {
            "range": "8fe9d6!A1:H14",
            "filtered_out_rows": [
                4,
                5,
                6
            ],
            "filter_infos": [
                {
                    "col": "E",
                    "conditions": [
                        {
                            "filter_type": "number",
                            "compare_type": "less",
                            "expected": [
                                "50%"
                            ]
                        }
                    ]
                }
            ]
        }
    }
}

错误码

HTTP状态码	错误码	描述	排查建议
500	1315201	Server Error	服务内部错误，详询客服
500	1315203	Server Error	服务内部错误，详询客服
400	1310213	Permission Fail	没有文档相应权限。参考云文档常见问题问题 2 和问题 3 开通应用权限和文档权限
400	1310215	Sheet Id Not Found	工作表 ID 未找到。请检查工作表的 ID 是否正确。获取方式见获取工作表
400	1310229	Wrong URL Param	URL 路径参数错误。请检查路径参数
400	1310226	Excess Limit	超出限制，参考响应体中的错误提示
400	1310217	Too Many Request	请求过于频繁。请稍后再试
400	1310235	Retry Later	请求超时，一般是由于服务器任务过多。请稍后重试
400	1310242	In Mix state	当前表格数据位于用户机房，正在将数据恢复到 SaaS 环境中，请稍后重试
400	1310249	Spreadsheet Deleted	表格已被删除。请恢复表格后重试