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

dingtalk.oapi.edu.sub.data.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。

请求参数

名称	类型	是否必须	示例值	更多限制	描述
stat_date	String	必须	20191201		统计日期
page_num	Number	必须	1		页码，必须大于0
page_size	Number	必须	20		每页大小，必须大于0
orders	OpenOrderDataRequest []	可选		最大列表长度：20	排序因子
└ field_name String 可选 act_usr_cnt_1d 排序字段名；字段名详见返回字段 └ order String 可选 asc 升序 asc; 降序 desc；

响应参数

名称	类型	示例值	描述
result	OpenEduSchoolStatisticalDataResponse []		结果集
└ sub_corp_area_lng String 123 所辖组织的地理经度 └ sub_corp_area_lat String 123 所辖组织的地理纬度 └ class_card_user_cnt_7d String 123 最近7天班级打卡使用人数 └ multi_patriarch_student_ratio String 123 多家长监管学生比率 └ none_patriarch_student_ratio String 123 无家长监管学生比率 └ rcv_ding_patriarch_cnt_7d String 123 最近7天接收DING的家长数 └ class_cnt_std String 123 班级数量 └ act_class_group_cnt_7d String 123 最近7天活跃的班级群数 └ active_mbr_cnt_std String 123 激活用户数 └ act_usr_ratio_1d String 123 最近1天活跃率 └ act_usr_cnt_1d String 123 最近1天活跃用户数 └ stat_date String 123 统计日期 └ mbr_cnt_std String 123 通讯录人数 └ send_msg_user_ratio_1d String 123 最近1天沟通率 └ corp_id String 123 教育局ID └ act_usr_ratio_7d String 123 最近7天活跃率 └ teacher_send_ding_cnt_7d String 123 最近7天教师钉消息发送数 └ two_patriarch_student_ratio String 123 双家长监管学生比率 └ ding_index_1d String 123 最近1天钉钉指数 └ student_cnt_std String 123 学生数量 └ sub_corp_name String 123 学校名称 └ class_group_user_cnt_7d String 123 最近7天班级群使用人数 └ class_card_user_cnt_1d String 123 最近1天班级打卡使用人数 └ live_launch_succ_cnt_1d String 123 最近1天成功发起直播次数 └ sub_corp_id String 123 学校id └ act_teacher_cnt_1d String 123 最近1天活跃教师数量 └ teacher_cnt_std String 123 教师数量 └ send_circle_post_cnt_7d String 123 最近7天班级圈发送数 └ teacher_send_ding_cnt_1d String 123 最近1天教师钉消息发送数 └ act_teacher_cnt_7d String 123 最近7天活跃教师数量 └ single_patriarch_student_ratio String 123 单家长监管学生比率 └ two_patriarch_student_cnt String 123 双家长监管学生数 └ auth_teacher_cnt_std String 123 数字化教师数量 └ act_patriarch_cnt_1d String 123 最近1天活跃家长数量 └ send_circle_post_cnt_1d String 123 最近1天班级圈发送数 └ act_class_circle_cnt_7d String 123 最近7天活跃的班级圈数 └ live_play_user_cnt_7d String 123 最近7天观看和回看直播人数 └ act_class_circle_cnt_1d String 123 最近1天活跃的班级圈数 └ send_msg_user_cnt_1d String 123 最近1天沟通用户数 └ act_class_group_cnt_1d String 123 最近1天活跃的班级群数 └ class_group_user_cnt_1d String 123 最近1天班级群使用人数 └ patriarch_cnt_std String 123 家长数量 └ send_msg_user_ratio_7d String 123 最近7天沟通率 └ mbr_active_ratio String 123 激活率 └ single_patriarch_student_cnt String 123 单家长监管学生数 └ ding_index_7d String 123 最近7天钉钉指数 └ act_patriarch_cnt_7d String 123 最近7天活跃家长数量 └ live_succ_time_len_1d String 123 最近1天成功发起直播时长 └ class_circle_user_cnt_1d String 123 最近1天班级圈使用人数 └ multi_patriarch_student_cnt String 123 多家长监管学生数 └ live_launch_succ_cnt_7d String 123 最近7天成功发起直播次数 └ live_play_user_cnt_1d String 123 最近1天观看和回看直播人数 └ rcv_ding_patriarch_cnt_1d String 123 最近1天接收DING的家长数 └ none_patriarch_student_cnt String 123 无家长监管学生数 └ class_circle_user_cnt_7d String 123 最近7天班级圈使用人数 └ act_usr_cnt_7d String 123 最近7天总活跃用户数 └ send_msg_user_cnt_7d String 123 最近7天沟通用户数 └ live_succ_time_len_7d String 123 最近7天成功发起直播时长
errmsg	String	123	错误信息
errcode	Number	123	错误码
success	Boolean	true	成功or失败

请求示例

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

DingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/edu/sub/data/get");
OapiEduSubDataGetRequest req = new OapiEduSubDataGetRequest();
req.setStatDate("20191201");
req.setPageNum(1L);
req.setPageSize(20L);
List<OpenOrderDataRequest> list2 = new ArrayList<OpenOrderDataRequest>();
OpenOrderDataRequest obj3 = new OpenOrderDataRequest();
list2.add(obj3);
obj3.setFieldName("act_usr_cnt_1d");
obj3.setOrder("asc");
req.setOrders(list2);
OapiEduSubDataGetResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());

IDingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/edu/sub/data/get");
OapiEduSubDataGetRequest req = new OapiEduSubDataGetRequest();
req.StatDate = "20191201";
req.PageNum = 1L;
req.PageSize = 20L;
List<OapiEduSubDataGetRequest.OpenOrderDataRequestDomain> list2 = new List<OapiEduSubDataGetRequest.OpenOrderDataRequestDomain>();
OapiEduSubDataGetRequest.OpenOrderDataRequestDomain obj3 = new OapiEduSubDataGetRequest.OpenOrderDataRequestDomain();
list2.Add(obj3);
obj3.FieldName = "act_usr_cnt_1d";
obj3.Order = "asc";
req.Orders_ = list2;
OapiEduSubDataGetResponse 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 OapiEduSubDataGetRequest;
$req->setStatDate("20191201");
$req->setPageNum("1");
$req->setPageSize("20");
$orders = new OpenOrderDataRequest;
$orders->field_name="act_usr_cnt_1d";
$orders->order="asc";
$req->setOrders(array($orders));
$resp = $c->execute($req, $access_token, "https://oapi.dingtalk.com/topapi/edu/sub/data/get");

curl -X POST "https://oapi.dingtalk.com/topapi/edu/sub/data/get" \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'access_token=a7c0737c-0a15-4474-b240-fe61052df3dc' \
-d 'orders=null' \
-d 'page_num=1' \
-d 'page_size=20' \
-d 'stat_date=20191201'

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

req=dingtalk.api.OapiEduSubDataGetRequest("https://oapi.dingtalk.com/topapi/edu/sub/data/get")

req.stat_date="20191201"
req.page_num=1
req.page_size=20
req.orders=""
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.edu.sub.data.get");
add_param(pRequest,"stat_date","20191201");
add_param(pRequest,"page_num","1");
add_param(pRequest,"page_size","20");
add_param(pRequest,"orders","数据结构JSON示例");
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.edu.sub.data.get', {
	'stat_date':'20191201',
	'page_num':'1',
	'page_size':'20',
	'orders':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

响应示例

JSON示例

{
    "result":[
        {
                "sub_corp_area_lng":"123",
                "sub_corp_area_lat":"123",
                "class_card_user_cnt_7d":"123",
                "multi_patriarch_student_ratio":"123",
                "none_patriarch_student_ratio":"123",
                "rcv_ding_patriarch_cnt_7d":"123",
                "class_cnt_std":"123",
                "act_class_group_cnt_7d":"123",
                "active_mbr_cnt_std":"123",
                "act_usr_ratio_1d":"123",
                "act_usr_cnt_1d":"123",
                "stat_date":"123",
                "mbr_cnt_std":"123",
                "send_msg_user_ratio_1d":"123",
                "corp_id":"123",
                "act_usr_ratio_7d":"123",
                "teacher_send_ding_cnt_7d":"123",
                "two_patriarch_student_ratio":"123",
                "ding_index_1d":"123",
                "student_cnt_std":"123",
                "sub_corp_name":"123",
                "class_group_user_cnt_7d":"123",
                "class_card_user_cnt_1d":"123",
                "live_launch_succ_cnt_1d":"123",
                "sub_corp_id":"123",
                "act_teacher_cnt_1d":"123",
                "teacher_cnt_std":"123",
                "send_circle_post_cnt_7d":"123",
                "teacher_send_ding_cnt_1d":"123",
                "act_teacher_cnt_7d":"123",
                "single_patriarch_student_ratio":"123",
                "two_patriarch_student_cnt":"123",
                "auth_teacher_cnt_std":"123",
                "act_patriarch_cnt_1d":"123",
                "send_circle_post_cnt_1d":"123",
                "act_class_circle_cnt_7d":"123",
                "live_play_user_cnt_7d":"123",
                "act_class_circle_cnt_1d":"123",
                "send_msg_user_cnt_1d":"123",
                "act_class_group_cnt_1d":"123",
                "class_group_user_cnt_1d":"123",
                "patriarch_cnt_std":"123",
                "send_msg_user_ratio_7d":"123",
                "mbr_active_ratio":"123",
                "single_patriarch_student_cnt":"123",
                "ding_index_7d":"123",
                "act_patriarch_cnt_7d":"123",
                "live_succ_time_len_1d":"123",
                "class_circle_user_cnt_1d":"123",
                "multi_patriarch_student_cnt":"123",
                "live_launch_succ_cnt_7d":"123",
                "live_play_user_cnt_1d":"123",
                "rcv_ding_patriarch_cnt_1d":"123",
                "none_patriarch_student_cnt":"123",
                "class_circle_user_cnt_7d":"123",
                "act_usr_cnt_7d":"123",
                "send_msg_user_cnt_7d":"123",
                "live_succ_time_len_7d":"123"
        }
    ],
    "errmsg":"123",
    "errcode":123,
    "success":true
}

异常示例

JSON示例

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

错误码解释

错误码	错误描述	解决方案

API工具

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

如何获得此API

FAQ

我要提问

返回
顶部

开放平台

钉钉API

dingtalk.oapi.edu.sub.data.get (学校粒度统计数据查询)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ