查询统计表头
查询考勤统计支持的日度统计或月度统计的统计表头。报表的表头信息可以在考勤统计-报表中查询到具体的报表信息，此接口专门用于查询表头数据
Tip: 调用统计开放接口api目前不返回请假统计和加班统计的新增字段类型
请求
| 项目 | 值 |
|---|---|
| HTTP URL | https://open.feishu.cn/open-apis/attendance/v1/user_stats_fields/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: 月度统计 |
start_date | int | 是 | 开始时间，格式为yyyyMMdd（无效字段） 示例值：20210316 |
end_date | int | 是 | 结束时间，格式为yyyyMMdd（时间间隔不超过 40 天）（无效字段） 示例值：20210323 |
请求体示例
json
{
"locale": "zh",
"stats_type": "daily",
"start_date": 20210316,
"end_date": 20210323
}响应
响应体
| 名称 | 类型 | 描述 |
|---|---|---|
code | int | 错误码，非 0 表示失败 |
msg | string | 错误描述 |
data | \- | - |
└ user_stats_field | user_stats_field | 统计数据表头 |
└ stats_type | string | 统计类型 可选值有： - daily: 日度统计 - month: 月度统计 |
└ user_id | string | 用户 ID，字段已废弃 |
└ fields | field\[\] | 字段列表 |
└ code | string | 分组编号 |
└ title | string | 分组名称 |
└ child_fields | child_field\[\] | 字段列表 |
└ code | string | 字段编号 |
└ title | string | 字段名称 |
└ time_unit | string | 时间单位(该字段已停止使用) |
响应体示例
json
{
"code": 0,
"msg": "",
"data": {
"user_stats_field": {
"fields": [
{
"child_fields": [
{
"code": "50103",
"title": "Employee ID"
}
],
"code": "501",
"title": "Basic info"
},
{
"child_fields": [
{
"code": "52108",
"title": "Attendance group name"
},
{
"code": "52101",
"title": "Required attendance days"
},
{
"code": "52102",
"title": "Days of attendance"
},
{
"code": "52104",
"time_unit": "Minute",
"title": "Required attendance duration"
},
{
"code": "52105",
"time_unit": "Minute",
"title": "Actual attendance duration"
},
{
"code": "52107",
"title": "Overtime hours"
}
],
"code": "521",
"title": "Attendance statistics"
},
{
"child_fields": [
{
"code": "52201",
"title": "Late in times"
},
{
"code": "52203",
"title": "Early out times"
},
{
"code": "52207",
"title": "No records"
}
],
"code": "522",
"title": "Abnormal statistics"
},
{
"child_fields": [
{
"code": "2021-03-16",
"title": "2021-03-16 Tue"
},
{
"code": "2021-03-17",
"title": "2021-03-17 Wed"
},
{
"code": "2021-03-18",
"title": "2021-03-18 Thu"
},
{
"code": "2021-03-19",
"title": "2021-03-19 Fri"
},
{
"code": "2021-03-20",
"title": "2021-03-20 Sat"
},
{
"code": "2021-03-21",
"title": "2021-03-21 Sun"
},
{
"code": "2021-03-22",
"title": "2021-03-22 Mon"
},
{
"code": "2021-03-23",
"title": "2021-03-23 Tue"
}
],
"code": "524",
"title": "Daily statistics"
}
],
"stats_type": "month",
"user_id": ""
}
}
}错误码
| HTTP状态码 | 错误码 | 描述 | 排查建议 |
|---|---|---|---|
| 400 | 1220001 | param is invalid | 入参校验失败，请根据具体返回的信息检查入参。例如“employee_type invalid”代表人员类型异常。如仍无法解决可联系 技术支持 |
| 400 | 1220002 | tenant_id is empty | 请检查入参中的 tenant_access_token是否正确 |
| 500 | 1228000 | 历史错误码，不再使用 | - |
| 400 | 1220600 | 通用错误信息 | 通用错误信息包含多条，详细的错误信息以及处理建议可参见 错误信息 |