cn.binarywang.wx.miniapp.api

接口 WxMaAnalysisService

所有已知实现类:

WxMaAnalysisServiceImpl

public interface WxMaAnalysisService

小程序数据分析相关接口。 文档：https://mp.weixin.qq.com/debug/wxadoc/dev/api/analysis.html

从以下版本开始:

2018-04-28

作者:

Charming

方法概要

限定符和类型	方法和说明
WxMaRetainInfo	getDailyRetainInfo(Date beginDate, Date endDate) 获取日留存数据。
List<WxMaSummaryTrend>	getDailySummaryTrend(Date beginDate, Date endDate) 查询概况趋势。
List<WxMaVisitTrend>	getDailyVisitTrend(Date beginDate, Date endDate) 获取日访问趋势。
WxMaRetainInfo	getMonthlyRetainInfo(Date beginDate, Date endDate) 获取月留存数据。
List<WxMaVisitTrend>	getMonthlyVisitTrend(Date beginDate, Date endDate) 获取月访问趋势。
WxMaUserPortrait	getUserPortrait(Date beginDate, Date endDate) 获取小程序新增或活跃用户的画像分布数据。
WxMaVisitDistribution	getVisitDistribution(Date beginDate, Date endDate) 获取访问分布。
List<WxMaVisitPage>	getVisitPage(Date beginDate, Date endDate) 获取访问页面数据。
WxMaRetainInfo	getWeeklyRetainInfo(Date beginDate, Date endDate) 获取周留存数据。
List<WxMaVisitTrend>	getWeeklyVisitTrend(Date beginDate, Date endDate) 获取周访问趋势。

方法详细资料

getDailySummaryTrend

List<WxMaSummaryTrend> getDailySummaryTrend(Date beginDate,
                                            Date endDate)
                                     throws WxErrorException

查询概况趋势。 温馨提示：小程序接口目前只能查询一天的数据，即 beginDate 和 endDate 一样

参数:

beginDate - 开始日期

endDate - 结束日期，限定查询1天数据，end_date允许设置的最大值为昨日

返回:

概况趋势列表

抛出:

WxErrorException - 获取失败时抛出，具体错误码请看文档

getDailyVisitTrend

List<WxMaVisitTrend> getDailyVisitTrend(Date beginDate,
                                        Date endDate)
                                 throws WxErrorException

获取日访问趋势。 温馨提示：小程序接口目前只能查询一天的数据，即 beginDate 和 endDate 一样

参数:

beginDate - 开始日期

endDate - 结束日期，限定查询1天数据，end_date允许设置的最大值为昨日

返回:

日访问趋势列表

抛出:

WxErrorException - 获取失败时抛出，具体错误码请看文档

getWeeklyVisitTrend

List<WxMaVisitTrend> getWeeklyVisitTrend(Date beginDate,
                                         Date endDate)
                                  throws WxErrorException

获取周访问趋势。 限定查询一个自然周的数据，时间必须按照自然周的方式输入： 如：20170306(周一), 20170312(周日)

参数:

beginDate - 开始日期，为周一日期

endDate - 结束日期，为周日日期，限定查询一周数据

返回:

周访问趋势列表（每项数据都是一个自然周汇总）

抛出:

WxErrorException - 获取失败时抛出，具体错误码请看文档

getMonthlyVisitTrend

List<WxMaVisitTrend> getMonthlyVisitTrend(Date beginDate,
                                          Date endDate)
                                   throws WxErrorException

获取月访问趋势。 限定查询一个自然月的数据，时间必须按照自然月的方式输入： 如：20170201(月初), 20170228(月末)

参数:

beginDate - 开始日期，为自然月第一天

endDate - 结束日期，为自然月最后一天，限定查询一个月数据

返回:

月访问趋势列表（每项数据都是一个自然月汇总）

抛出:

WxErrorException - 获取失败时抛出，具体错误码请看文档

getVisitDistribution

WxMaVisitDistribution getVisitDistribution(Date beginDate,
                                           Date endDate)
                                    throws WxErrorException

获取访问分布。 （此接口目前只能查询一天的数据，即 beginDate 和 endDate 一样）

参数:

beginDate - 开始日期

endDate - 结束日期，限定查询1天数据，end_date允许设置的最大值为昨日

返回:

访问分布对象

抛出:

WxErrorException - 获取失败时抛出，具体错误码请看文档

getDailyRetainInfo

WxMaRetainInfo getDailyRetainInfo(Date beginDate,
                                  Date endDate)
                           throws WxErrorException

获取日留存数据。 （此接口目前只能查询一天的数据，即 beginDate 和 endDate 一样）

参数:

beginDate - 开始日期

endDate - 结束日期，限定查询 1 天数据，endDate 允许设置的最大值为昨日

返回:

日留存信息对象

抛出:

WxErrorException - 获取失败时抛出，具体错误码请看文档

getWeeklyRetainInfo

WxMaRetainInfo getWeeklyRetainInfo(Date beginDate,
                                   Date endDate)
                            throws WxErrorException

获取周留存数据。 限定查询一个自然周的数据，时间必须按照自然周的方式输入： 如：20170306(周一), 20170312(周日)

参数:

beginDate - 开始日期，为周一日期

endDate - 结束日期，为周日日期，限定查询一周数据

返回:

周留存信息对象

抛出:

WxErrorException - 获取失败时抛出，具体错误码请看文档

getMonthlyRetainInfo

WxMaRetainInfo getMonthlyRetainInfo(Date beginDate,
                                    Date endDate)
                             throws WxErrorException

获取月留存数据。 限定查询一个自然月的数据，时间必须按照自然月的方式输入： 如：20170201(月初), 20170228(月末)

参数:

beginDate - 开始日期，为自然月第一天

endDate - 结束日期，为自然月最后一天，限定查询一个月数据

返回:

月留存信息对象

抛出:

WxErrorException - 获取失败时抛出，具体错误码请看文档

getVisitPage

List<WxMaVisitPage> getVisitPage(Date beginDate,
                                 Date endDate)
                          throws WxErrorException

获取访问页面数据。 温馨提示：此接口目前只能查询一天的数据，即 beginDate 和 endDate 一样

参数:

beginDate - 开始日期

endDate - 结束日期，限定查询1天数据，end_date允许设置的最大值为昨日

返回:

访问页面数据列表

抛出:

WxErrorException - 获取失败时抛出，具体错误码请看文档

getUserPortrait

WxMaUserPortrait getUserPortrait(Date beginDate,
                                 Date endDate)
                          throws WxErrorException

获取小程序新增或活跃用户的画像分布数据。 时间范围支持昨天、最近7天、最近30天。 其中，新增用户数为时间范围内首次访问小程序的去重用户数， 活跃用户数为时间范围内访问过小程序的去重用户数。 画像属性包括用户年龄、性别、省份、城市、终端类型、机型。

参数:

beginDate - 开始日期

endDate - 结束日期，开始日期与结束日期相差的天数限定为0/6/29，分别表示查询最近1/7/30天数据，end_date允许设置的最大值为昨日

返回:

小程序新增或活跃用户的画像分布数据对象

抛出:

WxErrorException - 获取失败时抛出，具体错误码请看文档