当日课程数据统计接口

功能说明

包含互动课堂和直播课堂数据

默认接口请求频率限制：20次/秒。

实现方法

REST URL

POST https://sdk.xylink.com/api/rest/edu/external/statistics/today/class/v1?enterpriseId=分配的企业id

请求参数说明

参数	参数类型	参数位置	必须	默认值	说明
departmentIds	List<Long>	Body	否	无	部门id集合(不超过10,否则报错)
areaType	Integer	Body	否	无	区域码(1-省，2-市，3-县)
areaCode	Long	Body	否	无	行政区域码
courseType	Integer	Body	否	无	0-今日互动课堂 1-今日直播课堂
areaTopNum	Integer	Body	否	10	开课地区top前多少名（比如10:前10名）默认值10

示例代码

请求消息体示例（Json）

{
   "departmentIds":[12345, 12398], //强制规定数量不超过10个
   "courseType":0,
   "areaTopNum":10
}

或者

{
  "areaType":1/2/3,
  "areaCode":123,
  "courseType":0,
  "areaTopNum":10
}

补充说明: 部门、区域码必须二选一条件查询数据,部门优先级更高

示例代码

返回结果示例：备注:时长单位都统一默认为毫秒

成功时返回结果数据，失败时返回小鱼RESTAPI错误码

{
  "totalCourse": 0, //今天课程总数
  "coursing": 0, //开课中的课堂数量
  "finished": 0, //已结束的课堂数量
  "topAreas": [ //开课地区top数据,以区域码查询时返回
    {
      "areaCode": 0, //区域码
      "areaName":"区域名称"
      "value": 0 //数量
    },
    {
      "areaCode": 0,
      "areaName":"区域名称"
      "value": 0
    }
  ],
  "viewCount": 0 //直播课堂观看总人次
}

返回参数说明

参数名称	说明
totalCourse	今天课程总数
coursing	开课中的课堂数量
finished	已结束的课堂数量
topAreas	开课地区top数据,以区域码查询时返回(对象)
viewCount	直播课堂观看总人次

2022-10-12 14:38:16

导出PDF文档