查询统计设置
查询考勤统计支持的日度统计或月度统计的统计表头。报表的表头信息可以在考勤统计-报表中查询到具体的报表信息，此接口专门用于查询表头数据。注意此接口和查询统计表头基本相同，区别点在于在兼容历史统计视图模型（历史统计数据模型可以按用户ID设置，后续统计升级为仅支持租户维度）
请求
| 项目 | 值 |
|---|---|
| HTTP URL | https://open.feishu.cn/open-apis/attendance/v1/user_stats_views/query |
| HTTP Method | POST |
| 接口频率限制 | 50 次/秒 |
| 支持的应用类型 | custom,isv |
| 权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用 开启任一权限即可 | attendance:task 写入打卡数据 attendance:task:readonly 导出打卡数据 |
请求头
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| Authorization | string | 是 | tenant_access_token 值格式："Bearer access_token" 示例值："Bearer t-7f1bcd13fc57d46bac21793a18e560" 了解更多：如何选择与获取 access token |
| Content-Type | string | 是 | 固定值："application/json; charset=utf-8" |
查询参数
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
employee_type | string | 是 | 响应体中的 user_id 的员工ID类型。如果没有后台管理权限，可使用通过手机号或邮箱获取用户 ID 示例值：employee_id 可选值有： - employee_id: 员工 employee ID，即飞书管理后台 > 组织架构 > 成员与部门 > 成员详情中的用户 ID - employee_no: 员工工号，即飞书管理后台 > 组织架构 > 成员与部门 > 成员详情中的工号 |
请求体
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
locale | string | 是 | 语言类型 示例值："zh" 可选值有： - en: 英语 - ja: 日语 - zh: 中文 |
stats_type | string | 是 | 统计类型 示例值："daily" 可选值有： - daily: 日度统计 - month: 月度统计 |
user_id | string | 否 | 操作者的用户id，对应employee_type * 必填字段(系统升级后，新系统要求必填) 示例值："dd31248a" |
请求体示例
json
{
"locale": "zh",
"stats_type": "daily",
"user_id": "dd31248a"
}响应
响应体
| 名称 | 类型 | 描述 |
|---|---|---|
code | int | 错误码，非 0 表示失败 |
msg | string | 错误描述 |
data | \- | - |
└ view | user_stats_view | 统计视图 |
└ view_id | string | 视图 ID，可用于更新统计设置 |
└ stats_type | string | 视图类型 可选值有： - daily: 日度统计 - month: 月度统计 |
└ user_id | string | 操作者的用户id，对应employee_type |
└ items | item\[\] | 用户设置字段 |
└ code | string | 标题编号 |
└ title | string | 标题名称 |
└ child_items | child_item\[\] | 子标题 |
└ code | string | 子标题编号 |
└ value | string | 开关字段，0：关闭，1：开启 |
└ title | string | 子标题名称 |
└ column_type | int | 列类型 * 0：未知（默认） * 1：复选框 * 2：文本 |
└ read_only | boolean | 是否只读 |
└ min_value | string | 最小值 |
└ max_value | string | 最大值 |
响应体示例
json
{
"code": 0,
"msg": "",
"data": {
"view": {
"items": [
{
"child_items": [
{
"code": "50101",
"column_type": 0,
"max_value": "",
"min_value": "",
"read_only": true,
"title": "姓名",
"value": "1"
},
{
"code": "50102",
"column_type": 0,
"max_value": "",
"min_value": "",
"read_only": false,
"title": "部门",
"value": "0"
},
{
"code": "50111",
"column_type": 0,
"max_value": "",
"min_value": "",
"read_only": false,
"title": "组织架构",
"value": "0"
},
{
"code": "50103",
"column_type": 0,
"max_value": "",
"min_value": "",
"read_only": false,
"title": "工号",
"value": "1"
},
{
"code": "50104",
"column_type": 0,
"max_value": "",
"min_value": "",
"read_only": false,
"title": "邮箱",
"value": "0"
},
{
"code": "50105",
"column_type": 0,
"max_value": "",
"min_value": "",
"read_only": false,
"title": "雇员类型",
"value": "0"
},
{
"code": "50106",
"column_type": 0,
"max_value": "",
"min_value": "",
"read_only": false,
"title": "序列",
"value": "0"
},
{
"code": "50107",
"column_type": 0,
"max_value": "",
"min_value": "",
"read_only": false,
"title": "入职时间",
"value": "0"
},
{
"code": "50108",
"column_type": 0,
"max_value": "",
"min_value": "",
"read_only": false,
"title": "离职时间",
"value": "0"
},
{
"code": "50109",
"column_type": 0,
"max_value": "",
"min_value": "",
"read_only": false,
"title": "状态",
"value": "0"
},
{
"code": "50110",
"column_type": 0,
"max_value": "",
"min_value": "",
"read_only": false,
"title": "直属上级",
"value": "0"
}
],
"code": "501",
"title": "基本信息"
},
{
"child_items": [
{
"code": "52108",
"column_type": 0,
"max_value": "",
"min_value": "",
"read_only": false,
"title": "考勤组名称",
"value": "1"
},
{
"code": "52101",
"column_type": 0,
"max_value": "",
"min_value": "",
"read_only": false,
"title": "应出勤天数",
"value": "1"
},
{
"code": "52102",
"column_type": 0,
"max_value": "",
"min_value": "",
"read_only": false,
"title": "工作日出勤天数",
"value": "1"
},
{
"code": "52103",
"column_type": 0,
"max_value": "",
"min_value": "",
"read_only": false,
"title": "休息日出勤天数",
"value": "0"
},
{
"code": "52104",
"column_type": 0,
"max_value": "",
"min_value": "",
"read_only": false,
"title": "应出勤时长",
"value": "1"
},
{
"code": "52105",
"column_type": 0,
"max_value": "",
"min_value": "",
"read_only": false,
"title": "实际出勤时长",
"value": "1"
},
{
"code": "52106",
"column_type": 0,
"max_value": "",
"min_value": "",
"read_only": false,
"title": "计薪工作时长",
"value": "0"
},
{
"code": "52107",
"column_type": 0,
"max_value": "",
"min_value": "",
"read_only": false,
"title": "加班工作时长",
"value": "1"
},
{
"code": "52109",
"column_type": 0,
"max_value": "",
"min_value": "",
"read_only": false,
"title": "加班时长(计加班费)\n",
"value": "0"
},
{
"code": "52110",
"column_type": 0,
"max_value": "",
"min_value": "",
"read_only": false,
"title": "加班时长(计为调休)\n",
"value": "0"
}
],
"code": "521",
"title": "出勤统计"
},
{
"child_items": [
{
"code": "52201",
"column_type": 0,
"max_value": "",
"min_value": "",
"read_only": false,
"title": "迟到次数",
"value": "1"
},
{
"code": "52202",
"column_type": 0,
"max_value": "",
"min_value": "",
"read_only": false,
"title": "迟到时长",
"value": "0"
},
{
"code": "52203",
"column_type": 0,
"max_value": "",
"min_value": "",
"read_only": false,
"title": "早退次数",
"value": "1"
},
{
"code": "52204",
"column_type": 0,
"max_value": "",
"min_value": "",
"read_only": false,
"title": "早退时长",
"value": "0"
},
{
"code": "52205",
"column_type": 0,
"max_value": "",
"min_value": "",
"read_only": false,
"title": "上班缺卡次数",
"value": "0"
},
{
"code": "52206",
"column_type": 0,
"max_value": "",
"min_value": "",
"read_only": false,
"title": "下班缺卡次数",
"value": "0"
},
{
"code": "52207",
"column_type": 0,
"max_value": "",
"min_value": "",
"read_only": false,
"title": "缺勤",
"value": "1"
},
{
"code": "52208",
"column_type": 0,
"max_value": "",
"min_value": "",
"read_only": false,
"title": "请假时长",
"value": "0"
},
{
"code": "52209",
"column_type": 0,
"max_value": "",
"min_value": "",
"read_only": false,
"title": "出差时长",
"value": "0"
},
{
"code": "52211",
"column_type": 0,
"max_value": "",
"min_value": "",
"read_only": false,
"title": "换班天数",
"value": "0"
},
{
"code": "52212",
"column_type": 0,
"max_value": "",
"min_value": "",
"read_only": false,
"title": "补卡次数",
"value": "0"
},
{
"code": "52213",
"column_type": 0,
"max_value": "",
"min_value": "",
"read_only": false,
"title": "外勤次数",
"value": "0"
},
{
"code": "52214",
"column_type": 0,
"max_value": "",
"min_value": "",
"read_only": false,
"title": "外出时长\t",
"value": "0"
}
],
"code": "522",
"title": "异常统计"
},
{
"child_items": [
{
"code": "52401",
"column_type": 0,
"max_value": "",
"min_value": "",
"read_only": false,
"title": "每日考勤结果",
"value": "1"
}
],
"code": "524",
"title": "每日统计"
}
],
"stats_type": "month",
"user_id": "ec8ddg56",
"view_id": "TmpZNU5qTTJORFF6T1RnNU5UTTNOakV6TWl0dGIyNTBhQT09"
}
}
}错误码
| HTTP状态码 | 错误码 | 描述 | 排查建议 |
|---|---|---|---|
| 400 | 1220001 | param is invalis | 入参校验失败，请根据具体返回的信息检查入参。例如“employee_type invalid”代表人员类型异常。如仍无法解决可联系 技术支持 |
| 400 | 1220002 | tenant_id is empty | 请检查入参中的 tenant_access_token是否正确 |
| 500 | 1228000 | 历史错误码，不再使用 | - |
| 400 | 1220600 | 通用错误信息 | 通用错误信息包含多条，详细的错误信息以及处理建议可参见 错误信息 |