课程相关数据统计接口

功能说明

具体包含各类课程的总数,互动、直播课程实时上课数量及观看人次

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

实现方法

REST URL

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

请求参数说明

参数	参数类型	参数位置	必须	默认值	说明
thirdDeptIds	List<String>	Body	否	无	三方批量部门ID(不超过10,否则报错)
areaType	Integer	Body	否	无	区域码(1-省，2-市，3-县)
areaCode	Long	Body	否	无	行政区域码

示例代码

请求消息体示例（Json）

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

或者

{
  "areaType":1/2/3,
  "areaCode":123
}

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

示例代码

返回结果示例：

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

{
  "areaCode": 520000, //区域码
  "areaName":"区域名称" //区域码对应的名称
  "interactCount": 102, //互动课程
  "interactWaitCount": 39, //未开始互动课程
  "interactOnCount": 21, //进行中互动课程
  "interactFinishCount": 42, //已结束互动课程
  "liveCount": 452, //直播课程总数
  "liveWaitCount": 440, //直播课程总数
  "liveOnCount": 12, //进行中直播课程总数
  "liveFinishCount": 0, //已结束直播课程总数
  "boutiqueCount": 0, //点播课程总数
  "liveViewCount": 0, //直播观看人次
  "boutiqueViewCount": 0, //点播观看人次
  "prepareCount": 0, //备课总讲次数
  "evaluationCount": 0, //听评课次数
  "childs": [ //子数据项
    {
      "areaCode": 0,
      "areaName":"",
      "interactCount": 0,
      "interactWaitCount": 0,
      "interactOnCount": 0,
      "interactFinishCount": 0,
      "liveCount": 0,
      "boutiqueCount": 0,
      "liveFinishCount": 0,
      "liveOnCount": 0,
      "liveWaitCount": 0,
      "evaluationCount": 0,
      "prepareCount": 0,
      "boutiqueViewCount": 0,
      "liveViewCount": 0
    }
  ]
}

返回参数说明

参数名称	说明
areaCode	区域码
areaName	区域名称
interactCount	互动课程
interactWaitCount	未开始互动课程
interactOnCount	直播课程总数
interactFinishCount	已结束互动课
liveCount	直播课程总数
liveWaitCount	直播等待课程总数
liveOnCount	进行中直播课程总数
liveFinishCount	已结束直播课程总数
boutiqueCount	点播课程总数
liveViewCount	直播观看人次
boutiqueViewCount	点播观看人次
prepareCount	备课总讲次数
evaluationCount	听评课次数

2022-10-12 14:38:28

导出PDF文档