文档中心 > API类目 > 钉钉API

dingtalk.oapi.kac.datav.annual_report.get (获取年报数据)

根据不同维度（员工/部门/组织），获取企业年报数据，涵盖当年参与视频会议次数/时长，当年参与语音会议次数/时长等等

公共参数

环境	HTTP请求地址	HTTPS请求地址
正式环境	http://gw.api.taobao.com/router/rest	https://eco.taobao.com/router/rest

名称	类型	是否必须	描述
access_token	String	是	钉钉提供的授权Token，想了解详情，ISV开发者请点击这里，企业开发者请点击这里。若有疑问，咨询邮箱dingding_open_dingtalk#list.alibaba-inc.com。

请求参数

名称	类型	是否必须	示例值	更多限制	描述
year	String	必须	2020	最大长度：32	年份标识
type	Number	必须	1		年报的数据维度，1-企业维度，2-部门维度，3-员工维度（员工维度的数据需要额外授权，请联系对接BD)
user_id	String	可选	11223344	最大长度：128	用户id，当type=3时该参数需存在
dept_id	Number	可选	23434		部门id，当type=2时该参数需存在

响应参数

名称	类型	示例值	描述
result	AnnualReportResponse	对象类型	返回结果对象
└ join_succ_voip_conf_user_cnt_1y Number 100 年累计参与（含发起）语音会议人次，仅当type=1时有效 └ join_succ_video_conf_user_cnt_1y Number 100 年累计参与（含发起）视频会议人次，仅当type=1时有效 └ outside_days_1y Number 100 年累计外勤天数 └ inner_group_cnt_1y Number 100 年累计新增内部群聊数量，仅当type=3时有效 └ process_inst_operate_cnt_1y Number 20 处理审批数 └ process_inst_submit_cnt_1y Number 20 发起审批数 └ at_check_days_1y Number 365 年累计打卡天数 └ live_join_succ_time_len_1y String 222.32 年累计参与直播时长（分钟） └ live_join_succ_cnt_1y Number 25 年累计参与直播次数 └ join_succ_voip_conf_len_1y String 234.51 年累计参与（含发起）语音会议时长（分钟） └ join_succ_voip_conf_num_1y Number 24 年累计参与（含发起）语音会议次数 └ join_succ_video_conf_len_1y String 340.52 年累计发起视频会议时长（分钟） └ join_succ_video_conf_num_1y Number 23 年累计参与（含发起）视频会议次数 └ use_micro_app_cnt_1y Number 20 年累计使用的应用数量 └ general_form_user_cnt_1y Number 300 年累计智能填表的人次，仅当type=1时有效 └ use_micro_user_cnt_1y Number 500 年累计使用的应用人数，仅当type=1,2时有效 └ send_report_cnt_1y Number 100 年累计发送日志数 └ create_smartwork_cnt_1y Number 100 年累计创建智能填表数 └ create_doc_cnt_1y Number 100 年累计创建文档数 └ join_calendar_cnt_1y Number 100 年累计参加日程数 └ send_ding_cnt_1y Number 100 年累计发送DING数 └ send_group_msg_cnt_1y Number 100 年累计发送群聊消息数 └ send_group_file_message_cnt_1y Number 100 年累计发送群文件数 └ new_group_cnt_1y Number 100 年累计新增群数 └ send_calendar_cnt_1y Number 100 年累计新建日程数 └ start_succ_video_conf_len_1y Number 100 发起视频会议时长（分钟） └ use_smartwork_cnt_1y Number 100 年累计参与智能填表数 └ recv_ding_cnt_1y Number 100 年累计接收DING数 └ at_me_msg_cnt_1y Number 100 年累计被at数 └ join_group_cnt_1y Number 100 年累计加入群数 └ act_usr_days_1y Number 100 年累计活跃天数 └ max_step_count_1y Number 100 年累计最高运动步数 └ use_doc_user_cnt_1y Number 100 使用文档用户数（创建、编辑、分享、阅读） └ send_report_user_cnt_1y Number 100 年累计发送日志人数 └ send_group_msg_user_cnt_1y Number 100 年累计发送群聊人数 └ send_calendar_user_cnt_1y Number 100 年累计新建日程人数 └ join_calendar_user_cnt_1y Number 100 年累计参加日程人数 └ min_process_duration_1y String 100.10 年累计审批最短处理时间（分钟） └ avg_process_duration_1y String 100.10 年累计审批平均处理时间（分钟） └ corp_app_process_inst_cnt_1y Number 100 年累计企业自建应用发起的审批数 └ create_process_cnt_1y Number 100 年累计创建审批数 └ send_message_group_cnt_1y Number 100 年累计活跃群数（发消息群） └ send_ding_user_cnt_1y Number 100 年累计发送DING人数 └ isw_msg_click_cnt_1y String 100 年累计阅读互动服务窗文章数量
errmsg	String	400002	错误信息
errcode	Number	参数错误	错误代码

请求示例

JAVA
.NET
PHP
CURL
Python
C/C++
NodeJS

DingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/kac/datav/annual_report/get");
OapiKacDatavAnnualReportGetRequest req = new OapiKacDatavAnnualReportGetRequest();
req.setYear("2020");
req.setType(1L);
req.setUserId("11223344");
req.setDeptId(23434L);
OapiKacDatavAnnualReportGetResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());

IDingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/kac/datav/annual_report/get");
OapiKacDatavAnnualReportGetRequest req = new OapiKacDatavAnnualReportGetRequest();
req.Year = "2020";
req.Type = 1L;
req.UserId = "11223344";
req.DeptId = 23434L;
OapiKacDatavAnnualReportGetResponse rsp = client.Execute(req, access_token);
Console.WriteLine(rsp.Body);

include "TopSdk.php";
date_default_timezone_set('Asia/Shanghai');

$c = new DingTalkClient(DingTalkConstant::$CALL_TYPE_OAPI, DingTalkConstant::$METHOD_POST , DingTalkConstant::$FORMAT_JSON);
$req = new OapiKacDatavAnnualReportGetRequest;
$req->setYear("2020");
$req->setType("1");
$req->setUserId("11223344");
$req->setDeptId("23434");
$resp = $c->execute($req, $access_token, "https://oapi.dingtalk.com/topapi/kac/datav/annual_report/get");

curl -X POST "https://oapi.dingtalk.com/topapi/kac/datav/annual_report/get" \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'access_token=dfba555b-d491-4671-9a79-f2e47a503277' \
-d 'dept_id=23434' \
-d 'type=1' \
-d 'user_id=11223344' \
-d 'year=2020'

# -*- coding: utf-8 -*-
import dingtalk.api

req=dingtalk.api.OapiKacDatavAnnualReportGetRequest("https://oapi.dingtalk.com/topapi/kac/datav/annual_report/get")

req.year="2020"
req.type=1
req.user_id="11223344"
req.dept_id=23434
try:
	resp= req.getResponse(access_token)
	print(resp)
except Exception,e:
	print(e)

pTopRequest pRequest = alloc_top_request();
pTopResponse pResponse = NULL;
pTaobaoClient pClient = alloc_taobao_client(url, appkey, appsecret);
set_api_name(pRequest,"dingtalk.oapi.kac.datav.annual_report.get");
add_param(pRequest,"year","2020");
add_param(pRequest,"type","1");
add_param(pRequest,"user_id","11223344");
add_param(pRequest,"dept_id","23434");
pResponse = top_execute(pClient,pRequest,sessionKey);
printf("ret code:%d\n",pResponse->code);
if(pResponse->code == 0){
	pTopResponseIterator ite = init_response_iterator(pResponse);
	pResultItem pResultItem = alloc_result_item();
	while(parseNext(ite, pResultItem) == 0){
		printf("%s:%s\n",pResultItem->key,pResultItem->value);
	}
	destroy_response_iterator(ite);
	destroy_result_item(pResultItem);
}
destroy_top_request(pRequest);
destroy_top_response(pResponse);
destroy_taobao_client(pClient);

TopClient = require('./topClient').TopClient;
var client = new TopClient({
	'appkey': 'appkey',
	'appsecret': 'secret',
	'REST_URL': 'http://gw.api.taobao.com/router/rest'
});

client.execute('dingtalk.oapi.kac.datav.annual_report.get', {
	'year':'2020',
	'type':'1',
	'user_id':'11223344',
	'dept_id':'23434'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

响应示例

JSON示例

{
    "result":{
        "join_succ_voip_conf_user_cnt_1y":100,
        "join_succ_video_conf_user_cnt_1y":100,
        "outside_days_1y":100,
        "inner_group_cnt_1y":100,
        "process_inst_operate_cnt_1y":20,
        "process_inst_submit_cnt_1y":20,
        "at_check_days_1y":365,
        "live_join_succ_time_len_1y":"222.32",
        "live_join_succ_cnt_1y":25,
        "join_succ_voip_conf_len_1y":"234.51",
        "join_succ_voip_conf_num_1y":24,
        "join_succ_video_conf_len_1y":"340.52",
        "join_succ_video_conf_num_1y":23,
        "use_micro_app_cnt_1y":20,
        "general_form_user_cnt_1y":300,
        "use_micro_user_cnt_1y":500,
        "send_report_cnt_1y":100,
        "create_smartwork_cnt_1y":100,
        "create_doc_cnt_1y":100,
        "join_calendar_cnt_1y":100,
        "send_ding_cnt_1y":100,
        "send_group_msg_cnt_1y":100,
        "send_group_file_message_cnt_1y":100,
        "new_group_cnt_1y":100,
        "send_calendar_cnt_1y":100,
        "start_succ_video_conf_len_1y":100,
        "use_smartwork_cnt_1y":100,
        "recv_ding_cnt_1y":100,
        "at_me_msg_cnt_1y":100,
        "join_group_cnt_1y":100,
        "act_usr_days_1y":100,
        "max_step_count_1y":100,
        "use_doc_user_cnt_1y":100,
        "send_report_user_cnt_1y":100,
        "send_group_msg_user_cnt_1y":100,
        "send_calendar_user_cnt_1y":100,
        "join_calendar_user_cnt_1y":100,
        "min_process_duration_1y":"100.10",
        "avg_process_duration_1y":"100.10",
        "corp_app_process_inst_cnt_1y":100,
        "create_process_cnt_1y":100,
        "send_message_group_cnt_1y":100,
        "send_ding_user_cnt_1y":100,
        "isw_msg_click_cnt_1y":"100"
    },
    "errmsg":"400002",
    "errcode":参数错误
}

异常示例

JSON示例

{
	"errcode":88,
	"errmsg":"ding talk error"
}

错误码解释

错误码	错误描述	解决方案

API工具

API测试工具错误码查询工具 SDK下载

如何获得此API

FAQ

我要提问

返回
顶部

开放平台

钉钉API

dingtalk.oapi.kac.datav.annual_report.get (获取年报数据)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ