企业可通过调用本接口,根据汇报表单id查询企业微信“汇报应用”的汇报统计汇总信息。该接口只能拉取到已经汇总的统计数据,对于尚未完成汇总的周期不会返回。
请求方式:POST(HTTPS)
请求地址:https://qyapi.weixin.qq.com/cgi-bin/oa/journal/get_stat_list?access_token=ACCESS_TOKEN
请求示例
{
"template_id": "3TmALk1ogfgKiQE3e3jRwnTUhMTh8vca1N8zUVNUx",
"starttime": 1604160000,
"endtime": 1606363092
}
参数说明:
参数 | 必须 | 类型 | 说明 |
---|---|---|---|
access_token | 是 | string | 调用接口凭证 |
template_id | 是 | string | 汇报表单id,不多于256字节 |
starttime | 是 | uint64 | 开始时间 |
endtime | 是 | uint64 | 结束时间,时间区间最大长度为一年 |
权限说明:
调用的应用需要满足如下的权限:
应用类型 | 权限要求 |
---|---|
自建应用 | 需要配置到「汇报 - 可调用接口的应用」中 |
代开发应用 | 暂不支持 |
第三方应用 | 暂不支持 |
注: 从2023年12月1日0点起,不再支持通过系统应用secret调用接口,存量企业暂不受影响 查看详情
返回结果:
{
"errcode": 0,
"errmsg": "ok",
"stat_list": [
{
"template_id": "3TmALk1ogfgKiQE3e3jRwnTUhMTh8vca1N8zUVNU",
"template_name": "日报",
"report_range": {
"user_list": [
{
"userid": "user1"
}
],
"party_list": [
{
"open_partyid": "1"
}
],
"tag_list": []
},
"white_range": {
"user_list": [],
"party_list": [],
"tag_list": []
},
"receivers": {
"user_list": [
{
"userid": "user3"
}
],
"tag_list": [],
"leader_list": []
},
"cycle_begin_time": 1606147200,
"cycle_end_time": 1606233600,
"stat_begin_time": 1606147200,
"stat_end_time": 1606230000,
"report_list": [
{
"user": {
"userid": "user2"
},
"itemlist": [
{
"journaluuid": "4U9abSUrpY78VNxeNNv3J5TW5e9VLj8cDymH9py1Efpuj5X8QCDQx3stKr69pia3UL8auRjrCMsiRjgzL8mvKnff",
"reporttime": 1606218548,
"flag": 0
}
]
}
],
"unreport_list": [
{
"user": {
"userid": "user1"
},
"itemlist": [
{
"journaluuid": "",
"reporttime": 1606147200,
"flag": 0
}
]
},
{
"user": {
"userid": "user3"
},
"itemlist": [
{
"journaluuid": "",
"reporttime": 1606147200,
"flag": 0
}
]
}
],
"report_type": 2
}
]
}
参数说明:
参数 | 类型 | 说明 |
---|---|---|
errcode | int32 | 返回码 |
errmsg | string | 错误码描述 |
stat_list | obj[] | 统计数据列表 |
stat_list.template_id | string | 汇报表单id |
stat_list.template_name | string | 汇报表单名称 |
stat_list.report_range | obj | 汇报人员范围 |
stat_list.report_range.user_list | obj[] | 指定人集合 |
stat_list.report_range.user_list.userid | string | 用户id |
stat_list.report_range.party_list | obj[] | 指定部门集合 |
stat_list.report_range.party_list.open_partyid | string | 部门id |
stat_list.report_range.tag_list | obj[] | 指定标签集合 |
stat_list.report_range.tag_list.open_tagid | string | 标签id |
stat_list.white_range | obj | 白名单集合 |
stat_list.white_range.user_list | obj[] | 指定人集合 |
stat_list.white_range.user_list.userid | string | 用户id |
stat_list.white_range.party_list | obj[] | 指定部门集合 |
stat_list.white_range.party_list.open_partyid | string | 部门id |
stat_list.white_range.tag_list | obj[] | 指定标签集合 |
stat_list.white_range.tag_list.open_tagid | string | 标签id |
stat_list.receivers | obj | 固定汇报对象 |
stat_list.receivers.user_list | obj[] | 指定人集合 |
stat_list.receivers.user_list.userid | string | 用户id |
stat_list.receivers.tag_list | obj[] | 指定标签集合 |
stat_list.receivers.tag_list.open_tagid | string | 标签id |
stat_list.receivers.leader_list | obj[] | 指定上级集合 |
stat_list.receivers.leader_list.level | uint64 | 上级级别从1开始 |
stat_list.cycle_begin_time | uint64 | 周期开始时间 |
stat_list.cycle_end_time | uint64 | 周期结束时间 |
stat_list.stat_begin_time | uint64 | 统计开始时间 |
stat_list.stat_end_time | uint64 | 统计结束时间 |
stat_list.report_list | obj[] | 已汇报用户列表 |
stat_list.report_list.user | obj | 汇报用户 |
stat_list.report_list.user.userid | string | 用户id |
stat_list.report_list.itemlist | obj[] | 汇报记录列表 |
stat_list.report_list.itemlist.journaluuid | string | 汇报记录id |
stat_list.report_list.itemlist.reporttime | uint32 | 汇报时间 |
stat_list.report_list.itemlist.flag | uint32 | 是否迟交,1迟交;0非迟交 |
stat_list.unreport_list | obj[] | 未汇报用户列表 |
stat_list.unreport_list.user | obj | 未汇报用户 |
stat_list.unreport_list.user.userid | string | 用户id |
stat_list.report_type | uint32 | 汇报方式:2按日汇报; 3按周汇报; 4按月汇报 |
错误说明:
错误码 | 说明 |
---|---|
301065 | 无汇报应用数据拉取权限 |
301066 | 请求参数错误 |
301067 | 接口内部失败 |