小程序开发API之数据上报、数据分析

OStack程序员社区-中国程序员成长平台 › 门户 › 编程› 移动开发›小程序云开发高级教程

原作者: [db:作者] 来自: [db:来源] 收藏邀请

数据上报

wx.reportMonitor(string name, number value)

自定义业务数据监控上报接口。

参数
string name
监控ID，在「小程序管理后台」新建数据指标后获得
number value
上报数值，经处理后会在「小程序管理后台」上展示每分钟的上报总量

使用说明
使用前，需要在「小程序管理后台-运维中心-性能监控-业务数据监控」中新建监控事件，配置监控描述与告警类型。每一个监控事件对应唯一的监控ID，开发者最多可以创建128个监控事件。
示例代码
wx.reportMonitor(‘1’, 1)

数据分析

wx.reportAnalytics(string eventName, Object data)

自定义分析数据上报接口。使用前，需要在小程序管理后台自定义分析中新建事件，配置好事件名与字段。
参数
string eventName
事件名
Object data
上报的自定义数据。

示例代码
wx.reportAnalytics(‘purchase’, {
price: 120,
color: ‘red’
})

访问留存

getAnalysisDailyRetain

本接口应在后端服务器调用，详细说明参见后端API。
获取用户访问小程序日留存

请求地址
POST https://api.weixin.qq.com/datacube/getweanalysisappiddailyretaininfo?access_token=ACCESS_TOKEN

请求参数

返回值
返回的 JSON 数据包

visit_uv_new 的结构

visit_uv 的结构

请求数据示例

{
  "begin_date": "20170313",
  "end_date": "20170313"
}

返回数据示例
{
  "ref_date": "20170313",
  "visit_uv_new": [
    {
      "key": 0,
      "value": 5464
    }
  ],
  "visit_uv": [
    {
      "key": 0,
      "value": 55500
    }
  ]
}

getAnalysisMonthlyRetain

本接口应在后端服务器调用，详细说明参见后端API。
获取用户访问小程序月留存
请求地址
POST https://api.weixin.qq.com/datacube/getweanalysisappidmonthlyretaininfo?access_token=ACCESS_TOKEN
请求参数

返回值
返回的 JSON 数据包

visit_uv_new 的结构

visit_uv 的结构

注意
请求json和返回json与天的一致，这里限定查询一个自然月的数据，时间必须按照自然月的方式输入：如：20170201(月初), 20170228(月末)
请求数据示例

{
  "begin_date": "20170201",
  "end_date": "20170228"
}

返回数据示例

{
  "ref_date": "201702",
  "visit_uv_new": [
    {
      "key": 0,
      "value": 346249
    }
  ],
  "visit_uv": [
    {
      "key": 0,
      "value": 346249
    }
  ]
}

getAnalysisWeeklyRetain

本接口应在后端服务器调用，详细说明参见后端API。
获取用户访问小程序周留存
请求地址
POST https://api.weixin.qq.com/datacube/getweanalysisappidweeklyretaininfo?access_token=ACCESS_TOKEN

请求参数

返回值
返回的 JSON 数据包

visit_uv_new 的结构

visit_uv 的结构

注意
请求json和返回json与天的一致，这里限定查询一个自然周的数据，时间必须按照自然周的方式输入：如：20170306(周一), 20170312(周日)

请求数据示例

{
  "begin_date": "20170306",
  "end_date": "20170312"
}

返回数据示例

{
  "ref_date": "20170306-20170312",
  "visit_uv_new": [
    {
      "key": 0,
      "value": 0
    },
    {
      "key": 1,
      "value": 16853
    }
  ],
  "visit_uv": [
    {
      "key": 0,
      "value": 0
    },
    {
      "key": 1,
      "value": 99310
    }
  ]
}

数据概况

getAnalysisDailySummary

本接口应在后端服务器调用，详细说明参见后端API。
获取用户访问小程序数据概况
请求地址
POST https://api.weixin.qq.com/datacube/getweanalysisappiddailysummarytrend?access_token=ACCESS_TOKEN

请求参数

返回值
返回的 JSON 数据包

list 的结构

请求数据示例

{
  "begin_date": "20170313",
  "end_date": "20170313"
}

返回数据示例

{
  "list": [
    {
      "ref_date": "20170313",
      "visit_total": 391,
      "share_pv": 572,
      "share_uv": 383
    }
  ]
}

访问趋势

getAnalysisDailyVisitTrend

本接口应在后端服务器调用，详细说明参见后端API。
获取用户访问小程序数据日趋势
请求地址
POST https://api.weixin.qq.com/datacube/getweanalysisappiddailyvisittrend?access_token=ACCESS_TOKEN

请求参数

返回值
返回的 JSON 数据包

list 的结构

请求数据示例

{
  "begin_date": "20170313",
  "end_date": "20170313"
}

返回数据示例

{
  "list": [
    {
      "ref_date": "20170313",
      "session_cnt": 142549,
      "visit_pv": 472351,
      "visit_uv": 55500,
      "visit_uv_new": 5464,
      "stay_time_session": 0,
      "visit_depth": 1.9838
    }
  ]
}

getAnalysisMonthlyVisitTrend

本接口应在后端服务器调用，详细说明参见后端API。
获取用户访问小程序数据月趋势
请求地址
POST https://api.weixin.qq.com/datacube/getweanalysisappidmonthlyvisittrend?access_token=ACCESS_TOKEN

请求参数

返回值
返回的 JSON 数据包
list 的结构

访问周期说明
限定查询一个自然月的数据，时间必须按照自然月的方式输入：如：20170301, 20170331
请求数据示例

{
  "begin_date": "20170301",
  "end_date": "20170331"
}

返回数据示例

{
  "list": [
    {
      "ref_date": "201703",
      "session_cnt": 126513,
      "visit_pv": 426113,
      "visit_uv": 48659,
      "visit_uv_new": 6726,
      "stay_time_session": 56.4112,
      "visit_depth": 2.0189
    }
  ]
}

getAnalysisWeeklyVisitTrend

本接口应在后端服务器调用，详细说明参见后端API。
获取用户访问小程序数据周趋势
请求地址
POST https://api.weixin.qq.com/datacube/getweanalysisappidweeklyvisittrend?access_token=ACCESS_TOKEN

请求参数

返回值
返回的 JSON 数据包

list 的结构

访问周期说明
限定查询一个自然周的数据，时间必须按照自然周的方式输入：如：20170306(周一), 20170312(周日)
请求数据示例

{
  "begin_date": "20170306",
  "end_date": "20170312"
}

返回数据示例

{
  "list": [
    {
      "ref_date": "20170306-20170312",
      "session_cnt": 986780,
      "visit_pv": 3251840,
      "visit_uv": 189405,
      "visit_uv_new": 45592,
      "stay_time_session": 54.5346,
      "visit_depth": 1.9735
    }
  ]
}

getAnalysisUserPortrait

本接口应在后端服务器调用，详细说明参见后端API。
获取小程序新增或活跃用户的画像分布数据。时间范围支持昨天、最近7天、最近30天。其中，新增用户数为时间范围内首次访问小程序的去重用户数，活跃用户数为时间范围内访问过小程序的去重用户数。
请求地址
POST https://api.weixin.qq.com/datacube/getweanalysisappiduserportrait?access_token=ACCESS_TOKEN

请求参数

返回值
返回的 JSON 数据包

visit_uv_new 的结构

province 的结构

city 的结构

genders 的结构

platforms 的结构

devices 的结构

ages 的结构

请求数据示例

{
  "begin_date": "20170611",
  "end_date": "20170617"
}

返回数据示例

{
  "ref_date": "20170611",
  "visit_uv_new": {
    "province": [
      {
        "id": 31,
        "name": "广东省",
        "value": 215
      }
    ],
    "city": [
      {
        "id": 3102,
        "name": "广州",
        "value": 78
      }
    ],
    "genders": [
      {
        "id": 1,
        "name": "男",
        "value": 2146
      }
    ],
    "platforms": [
      {
        "id": 1,
        "name": "iPhone",
        "value": 27642
      }
    ],
    "devices": [
      {
        "name": "OPPO R9",
        "value": 61
      }
    ],
    "ages": [
      {
        "id": 1,
        "name": "17岁以下",
        "value": 151
      }
    ]
  },
  "visit_uv": {
    "province": [
      {
        "id": 31,
        "name": "广东省",
        "value": 1341
      }
    ],
    "city": [
      {
        "id": 3102,
        "name": "广州",
        "value": 234
      }
    ],
    "genders": [
      {
        "id": 1,
        "name": "男",
        "value": 14534
      }
    ],
    "platforms": [
      {
        "id": 1,
        "name": "iPhone",
        "value": 21750
      }
    ],
    "devices": [
      {
        "name": "OPPO R9",
        "value": 617
      }
    ],
    "ages": [
      {
        "id": 1,
        "name": "17岁以下",
        "value": 3156
      }
    ]
  }
}

getAnalysisVisitDistribution

本接口应在后端服务器调用，详细说明参见后端API。
获取用户小程序访问分布数据
请求地址
POST https://api.weixin.qq.com/datacube/getweanalysisappidvisitdistribution?access_token=ACCESS_TOKEN

请求参数

返回值
返回的 JSON 数据包

list 的结构

index 的合法值

item_list 的结构

请求数据示例

{
  "begin_date": "20170313",
  "end_date": "20170313"
}

返回数据示例

{
  "ref_date": "20170313",
  "list": [
    {
      "index": "access_source_session_cnt",
      "item_list": [
        {
          "key": 10,
          "value": 5
        },
        {
          "key": 8,
          "value": 687
        },
        {
          "key": 7,
          "value": 10740
        },
        {
          "key": 6,
          "value": 1961
        },
        {
          "key": 5,
          "value": 677
        },
        {
          "key": 4,
          "value": 653
        },
        {
          "key": 3,
          "value": 1120
        },
        {
          "key": 2,
          "value": 10243
        },
        {
          "key": 1,
          "value": 116578
        }
      ]
    },
    {
      "index": "access_staytime_info",
      "item_list": [
        {
          "key": 8,
          "value": 16329
        },
        {
          "key": 7,
          "value": 19322
        },
        {
          "key": 6,
          "value": 21832
        },
        {
          "key": 5,
          "value": 19539
        },
        {
          "key": 4,
          "value": 29670
        },
        {
          "key": 3,
          "value": 19667
        },
        {
          "key": 2,
          "value": 11794
        },
        {
          "key": 1,
          "value": 4511
        }
      ]
    },
    {
      "index": "access_depth_info",
      "item_list": [
        {
          "key": 5,
          "value": 217
        },
        {
          "key": 4,
          "value": 3259
        },
        {
          "key": 3,
          "value": 32445
        },
        {
          "key": 2,
          "value": 63542
        },
        {
          "key": 1,
          "value": 43201
        }
      ]
    }
  ]
}

访问来源 key 对应关系（index="access_source_session_cnt")，场景值说明参见场景值

访问时长 key 对应关系（index="access_staytime_info"）

平均访问深度 key 对应关系（index="access_depth_info"）

getAnalysisVisitPage

本接口应在后端服务器调用，详细说明参见后端API。
访问页面。目前只提供按 page_visit_pv 排序的 top200。
请求地址
POST https://api.weixin.qq.com/datacube/getweanalysisappidvisitpage?access_token=ACCESS_TOKEN

请求参数

返回值
返回的 JSON 数据包

请求数据示例

{
  "begin_date": "20170313",
  "end_date": "20170313"
}

返回数据示例

{
  "ref_date": "20170313",
  "list": [
    {
      "page_path": "pages/main/main.html",
      "page_visit_pv": 213429,
      "page_visit_uv": 55423,
      "page_staytime_pv": 8.139198,
      "entrypage_pv": 117922,
      "exitpage_pv": 61304,
      "page_share_pv": 180,
      "page_share_uv": 166
    },
    {
      "page_path": "pages/linedetail/linedetail.html",
      "page_visit_pv": 155030,
      "page_visit_uv": 42195,
      "page_staytime_pv": 35.462395,
      "entrypage_pv": 21101,
      "exitpage_pv": 47051,
      "page_share_pv": 47,
      "page_share_uv": 42
    },
    {
      "page_path": "pages/search/search.html",
      "page_visit_pv": 65011,
      "page_visit_uv": 24716,
      "page_staytime_pv": 6.889634,
      "entrypage_pv": 1811,
      "exitpage_pv": 3198,
      "page_share_pv": 0,
      "page_share_uv": 0
    },
    {
      "page_path": "pages/stationdetail/stationdetail.html",
      "page_visit_pv": 29953,
      "page_visit_uv": 9695,
      "page_staytime_pv": 7.558508,
      "entrypage_pv": 1386,
      "exitpage_pv": 2285,
      "page_share_pv": 0,
      "page_share_uv": 0
    },
    {
      "page_path": "pages/switch-city/switch-city.html",
      "page_visit_pv": 8928,
      "page_visit_uv": 4017,
      "page_staytime_pv": 9.22659,
      "entrypage_pv": 748,
      "exitpage_pv": 1613,
      "page_share_pv": 0,
      "page_share_uv": 0
    }
  ]
}