cn.binarywang.wx.miniapp.api.WxMaAnalysisService Maven / Gradle / Ivy
package cn.binarywang.wx.miniapp.api;
import cn.binarywang.wx.miniapp.bean.analysis.*;
import me.chanjar.weixin.common.error.WxErrorException;
import java.util.Date;
import java.util.List;
/**
* 小程序数据分析相关接口
* 文档：https://mp.weixin.qq.com/debug/wxadoc/dev/api/analysis.html
*
* @author Charming
* @since 2018-04-28
*/
public interface WxMaAnalysisService {
/**
* 查询概况趋势
* 温馨提示：小程序接口目前只能查询一天的数据，即 beginDate 和 endDate 一样
*
* @param beginDate 开始日期
* @param endDate 结束日期，限定查询1天数据，end_date允许设置的最大值为昨日
* @return 概况趋势
* @throws WxErrorException 获取失败时抛出，具体错误码请看文档
*/
List getDailySummaryTrend(Date beginDate, Date endDate) throws WxErrorException;
/**
* 获取日访问趋势
* 温馨提示：小程序接口目前只能查询一天的数据，即 beginDate 和 endDate 一样
*
* @param beginDate 开始日期
* @param endDate 结束日期，限定查询1天数据，end_date允许设置的最大值为昨日
* @return 日访问趋势
* @throws WxErrorException 获取失败时抛出，具体错误码请看文档
*/
List getDailyVisitTrend(Date beginDate, Date endDate) throws WxErrorException;
/**
* 获取周访问趋势
* 限定查询一个自然周的数据，时间必须按照自然周的方式输入： 如：20170306(周一), 20170312(周日)
*
* @param beginDate 开始日期，为周一日期
* @param endDate 结束日期，为周日日期，限定查询一周数据
* @return 周访问趋势（每项数据都是一个自然周汇总）
* @throws WxErrorException 获取失败时抛出，具体错误码请看文档
*/
List getWeeklyVisitTrend(Date beginDate, Date endDate) throws WxErrorException;
/**
* 获取月访问趋势
* 限定查询一个自然月的数据，时间必须按照自然月的方式输入： 如：20170201(月初), 20170228(月末)
*
* @param beginDate 开始日期，为自然月第一天
* @param endDate 结束日期，为自然月最后一天，限定查询一个月数据
* @return 月访问趋势（每项数据都是一个自然月汇总）
* @throws WxErrorException 获取失败时抛出，具体错误码请看文档
*/
List getMonthlyVisitTrend(Date beginDate, Date endDate) throws WxErrorException;
/**
* 获取访问分布
* （此接口目前只能查询一天的数据，即 beginDate 和 endDate 一样）
*
* @param beginDate 开始日期，为周一日期
* @param endDate 结束日期，限定查询1天数据，end_date允许设置的最大值为昨日
* @return 访问分布
* @throws WxErrorException 获取失败时抛出，具体错误码请看文档
*/
WxMaVisitDistribution getVisitDistribution(Date beginDate, Date endDate) throws WxErrorException;
/**
* 日留存
* （此接口目前只能查询一天的数据，即 beginDate 和 endDate 一样）
*
* @param beginDate 开始日期，为周一日期
* @param endDate 结束日期，限定查询 1 天数据，endDate 允许设置的最大值为昨日
* @return 日留存
* @throws WxErrorException 获取失败时抛出，具体错误码请看文档
*/
WxMaRetainInfo getDailyRetainInfo(Date beginDate, Date endDate) throws WxErrorException;
/**
* 周留存
* 限定查询一个自然周的数据，时间必须按照自然周的方式输入： 如：20170306(周一), 20170312(周日)
*
* @param beginDate 开始日期，为周一日期
* @param endDate 结束日期，为周日日期，限定查询一周数据
* @return 周留存
* @throws WxErrorException 获取失败时抛出，具体错误码请看文档
*/
WxMaRetainInfo getWeeklyRetainInfo(Date beginDate, Date endDate) throws WxErrorException;
/**
* 月留存
* 限定查询一个自然月的数据，时间必须按照自然月的方式输入： 如：20170201(月初), 20170228(月末)
*
* @param beginDate 开始日期，为自然月第一天
* @param endDate 结束日期，为自然月最后一天，限定查询一个月数据
* @return 月留存
* @throws WxErrorException 获取失败时抛出，具体错误码请看文档
*/
WxMaRetainInfo getMonthlyRetainInfo(Date beginDate, Date endDate) throws WxErrorException;
/**
* 获取访问页面数据
* 温馨提示：此接口目前只能查询一天的数据，即 beginDate 和 endDate 一样
*
* @param beginDate 开始日期
* @param endDate 结束日期，限定查询1天数据，end_date允许设置的最大值为昨日
* @return 访问页面数据
* @throws WxErrorException 获取失败时抛出，具体错误码请看文档
*/
List getVisitPage(Date beginDate, Date endDate) throws WxErrorException;
/**
* 获取小程序新增或活跃用户的画像分布数据
* 时间范围支持昨天、最近7天、最近30天。
* 其中，新增用户数为时间范围内首次访问小程序的去重用户数，
* 活跃用户数为时间范围内访问过小程序的去重用户数。
* 画像属性包括用户年龄、性别、省份、城市、终端类型、机型。
*
* @param beginDate 开始日期
* @param endDate 结束日期，开始日期与结束日期相差的天数限定为0/6/29，分别表示查询最近1/7/30天数据，end_date允许设置的最大值为昨日
* @return 小程序新增或活跃用户的画像分布数据
* @throws WxErrorException 获取失败时抛出，具体错误码请看文档
*/
WxMaUserPortrait getUserPortrait(Date beginDate, Date endDate) throws WxErrorException;
}