me.chanjar.weixin.mp.api.WxMpDataCubeService Maven / Gradle / Ivy
The newest version!
package me.chanjar.weixin.mp.api;
import me.chanjar.weixin.common.error.WxErrorException;
import me.chanjar.weixin.mp.bean.datacube.*;
import java.util.Date;
import java.util.List;
/**
* 统计分析相关接口
* Created by Binary Wang on 2016/8/23.
*
* @author binarywang (https://github.com/binarywang)
*/
public interface WxMpDataCubeService {
//*******************用户分析数据接口***********************//
/**
*
* 获取用户增减数据
* 详情请见文档：用户分析数据接口
* 接口url格式：https://api.weixin.qq.com/datacube/getusersummary?access_token=ACCESS_TOKEN
*
*
* @param beginDate 开始时间
* @param endDate 最大时间跨度7天，endDate不能早于begingDate
* @return the user summary
* @throws WxErrorException the wx error exception
*/
List getUserSummary(Date beginDate, Date endDate) throws WxErrorException;
/**
*
* 获取累计用户数据
* 详情请见文档：用户分析数据接口
* 接口url格式：https://api.weixin.qq.com/datacube/getusercumulate?access_token=ACCESS_TOKEN
*
*
* @param beginDate 开始时间
* @param endDate 最大时间跨度7天，endDate不能早于begingDate
* @return the user cumulate
* @throws WxErrorException the wx error exception
*/
List getUserCumulate(Date beginDate, Date endDate) throws WxErrorException;
//*******************图文分析数据接口***********************//
/**
*
* 获取图文群发每日数据（getarticlesummary）
* 详情请见文档：图文分析数据接口
* 接口url格式：https://api.weixin.qq.com/datacube/getarticlesummary?access_token=ACCESS_TOKEN
*
*
* @param beginDate 开始时间
* @param endDate 最大时间跨度1天，endDate不能早于begingDate
* @return the article summary
* @throws WxErrorException the wx error exception
*/
List getArticleSummary(Date beginDate, Date endDate) throws WxErrorException;
/**
*
* 获取图文群发总数据（getarticletotal）
* 详情请见文档：图文分析数据接口
* 接口url格式：https://api.weixin.qq.com/datacube/getarticletotal?access_token=ACCESS_TOKEN
*
* @param beginDate 开始时间
* @param endDate 最大时间跨度1天，endDate不能早于begingDate
* @return the article total
* @throws WxErrorException the wx error exception
*/
List getArticleTotal(Date beginDate, Date endDate) throws WxErrorException;
/**
*
* 获取图文统计数据（getuserread）
* 详情请见文档：图文分析数据接口
* 接口url格式：https://api.weixin.qq.com/datacube/getuserread?access_token=ACCESS_TOKEN
*
* @param beginDate 开始时间
* @param endDate 最大时间跨度3天，endDate不能早于begingDate
* @return the user read
* @throws WxErrorException the wx error exception
*/
List getUserRead(Date beginDate, Date endDate) throws WxErrorException;
/**
*
* 获取图文统计分时数据（getuserreadhour）
* 详情请见文档：图文分析数据接口
* 接口url格式：https://api.weixin.qq.com/datacube/getuserreadhour?access_token=ACCESS_TOKEN
*
* @param beginDate 开始时间
* @param endDate 最大时间跨度1天，endDate不能早于begingDate
* @return the user read hour
* @throws WxErrorException the wx error exception
*/
List getUserReadHour(Date beginDate, Date endDate) throws WxErrorException;
/**
*
* 获取图文分享转发数据（getusershare）
* 详情请见文档：图文分析数据接口
* 接口url格式：https://api.weixin.qq.com/datacube/getusershare?access_token=ACCESS_TOKEN
*
* @param beginDate 开始时间
* @param endDate 最大时间跨度7天，endDate不能早于begingDate
* @return the user share
* @throws WxErrorException the wx error exception
*/
List getUserShare(Date beginDate, Date endDate) throws WxErrorException;
/**
*
* 获取图文分享转发分时数据（getusersharehour）
* 详情请见文档：图文分析数据接口
* 接口url格式：https://api.weixin.qq.com/datacube/getusersharehour?access_token=ACCESS_TOKEN
*
* @param beginDate 开始时间
* @param endDate 最大时间跨度1天，endDate不能早于begingDate
* @return the user share hour
* @throws WxErrorException the wx error exception
*/
List getUserShareHour(Date beginDate, Date endDate) throws WxErrorException;
//*******************消息分析数据接口***********************//
/**
*
* 获取消息发送概况数据（getupstreammsg）
* 详情请见文档：消息分析数据接口
* 接口url格式：https://api.weixin.qq.com/datacube/getupstreammsg?access_token=ACCESS_TOKEN
*
* @param beginDate 开始时间
* @param endDate 最大时间跨度7天，endDate不能早于begingDate
* @return the upstream msg
* @throws WxErrorException the wx error exception
*/
List getUpstreamMsg(Date beginDate, Date endDate) throws WxErrorException;
/**
*
* 获取消息分送分时数据（getupstreammsghour）
* 详情请见文档：消息分析数据接口
* 接口url格式：https://api.weixin.qq.com/datacube/getupstreammsghour?access_token=ACCESS_TOKEN
*
* @param beginDate 开始时间
* @param endDate 最大时间跨度1天，endDate不能早于begingDate
* @return the upstream msg hour
* @throws WxErrorException the wx error exception
*/
List getUpstreamMsgHour(Date beginDate, Date endDate) throws WxErrorException;
/**
*
* 获取消息发送周数据（getupstreammsgweek）
* 详情请见文档：消息分析数据接口
* 接口url格式：https://api.weixin.qq.com/datacube/getupstreammsgweek?access_token=ACCESS_TOKEN
*
* @param beginDate 开始时间
* @param endDate 最大时间跨度30天，endDate不能早于begingDate
* @return the upstream msg week
* @throws WxErrorException the wx error exception
*/
List getUpstreamMsgWeek(Date beginDate, Date endDate) throws WxErrorException;
/**
*
* 获取消息发送月数据（getupstreammsgmonth）
* 详情请见文档：消息分析数据接口
* 接口url格式：https://api.weixin.qq.com/datacube/getupstreammsgmonth?access_token=ACCESS_TOKEN
*
* @param beginDate 开始时间
* @param endDate 最大时间跨度30天，endDate不能早于begingDate
* @return the upstream msg month
* @throws WxErrorException the wx error exception
*/
List getUpstreamMsgMonth(Date beginDate, Date endDate) throws WxErrorException;
/**
*
* 获取消息发送分布数据（getupstreammsgdist）
* 详情请见文档：消息分析数据接口
* 接口url格式：https://api.weixin.qq.com/datacube/getupstreammsgdist?access_token=ACCESS_TOKEN
*
* @param beginDate 开始时间
* @param endDate 最大时间跨度15天，endDate不能早于begingDate
* @return the upstream msg dist
* @throws WxErrorException the wx error exception
*/
List getUpstreamMsgDist(Date beginDate, Date endDate) throws WxErrorException;
/**
*
* 获取消息发送分布周数据（getupstreammsgdistweek）
* 详情请见文档：消息分析数据接口
* 接口url格式：https://api.weixin.qq.com/datacube/getupstreammsgdistweek?access_token=ACCESS_TOKEN
*
* @param beginDate 开始时间
* @param endDate 最大时间跨度30天，endDate不能早于begingDate
* @return the upstream msg dist week
* @throws WxErrorException the wx error exception
*/
List getUpstreamMsgDistWeek(Date beginDate, Date endDate) throws WxErrorException;
/**
*
* 获取消息发送分布月数据（getupstreammsgdistmonth）
* 详情请见文档：消息分析数据接口
* 接口url格式：https://api.weixin.qq.com/datacube/getupstreammsgdistmonth?access_token=ACCESS_TOKEN
*
* @param beginDate 开始时间
* @param endDate 最大时间跨度30天，endDate不能早于begingDate
* @return the upstream msg dist month
* @throws WxErrorException the wx error exception
*/
List getUpstreamMsgDistMonth(Date beginDate, Date endDate) throws WxErrorException;
//*******************接口分析数据接口***********************//
/**
*
* 获取接口分析数据（getinterfacesummary）
* 详情请见文档：接口分析数据接口
* 接口url格式：https://api.weixin.qq.com/datacube/getinterfacesummary?access_token=ACCESS_TOKEN
*
* @param beginDate 开始时间
* @param endDate 最大时间跨度30天，endDate不能早于begingDate
* @return the interface summary
* @throws WxErrorException the wx error exception
*/
List getInterfaceSummary(Date beginDate, Date endDate) throws WxErrorException;
/**
*
* 获取接口分析分时数据（getinterfacesummaryhour）
* 详情请见文档：接口分析数据接口
* 接口url格式：https://api.weixin.qq.com/datacube/getinterfacesummaryhour?access_token=ACCESS_TOKEN
*
* @param beginDate 开始时间
* @param endDate 最大时间跨度1天，endDate不能早于begingDate
* @return the interface summary hour
* @throws WxErrorException the wx error exception
*/
List getInterfaceSummaryHour(Date beginDate, Date endDate) throws WxErrorException;
}