analysis.getPerformanceData

本接口应在服务器端调用,详细说明参见服务端API

本接口支持云调用。需开发者工具版本 >= 1.02.1904090(最新稳定版下载),wx-server-sdk >= 0.4.0

获取小程序启动性能,运行性能等数据。

调用方式:

HTTPS 调用

请求地址

POST https://api.weixin.qq.com/wxa/business/performance/boot?access_token=ACCESS_TOKEN

请求参数

属性 类型 默认值 必填 说明
access_token / cloudbase_access_token string 接口调用凭证
time Object 开始和结束日期的时间戳,时间跨度不能超过30天
module string 查询数据的类型
params Object 查询条件,比如机型,网络类型等等

time 的结构

属性 类型 默认值 必填 说明
end_timestamp string 结束日期时间戳
begin_timestamp string 开始日期时间戳

module 的合法值

说明 最低版本
10016 打开率, params字段可传入网络类型和机型
10017 启动各阶段耗时,params字段可传入网络类型和机型
10021 页面切换耗时,params数组字段可传入机型
10022 内存指标,params数组字段可传入机型
10023 内存异常,params数组字段可传入机型

params 的结构

属性 类型 默认值 必填 说明
field string 查询条件
value string 查询条件值

field 的合法值

说明 最低版本
networktype 网络类型作为查询条件,value=“-1,3g,4g,wifi”分别表示 全部网络类型,3G,4G,WIFI,不传networktype默认为全部网络类型
device_level 机型作为查询条件,此时value=“-1,1,2,3”分别表示 全部机型,高档机,中档机,低档机,不传device_level默认为全部机型
device 平台作为查询条件,此时value="-1,1,2"分别表示 全部平台,IOS平台,安卓平台,不传device默认为全部平台

返回值

Object

返回的 JSON 数据包

属性 类型 说明
errcode number 错误码
errmsg string 错误信息
body Object 返回的性能数据

body 的结构

属性 类型 说明
tables Object 返回的数据数组
count number 数组大小

tables 的结构

属性 类型 说明
id string 性能数据指标id
lines Object 按时间排列的性能数据
zh string 性能数据指标中文名

lines 的结构

属性 类型 说明
fields Object 单天的性能数据

fields 的结构

属性 类型 说明
refdate stirng 日期
value stirng 性能数据值

请求数据示例

{
	"time": {
		"end_timestamp": 1609689600,
		"begin_timestamp": 1609603200
	},
	"module": "10022",
	"params": [{
		"field": "networktype",
		"value": "wifi"
	}, {
		"field": "device_level",
		"value": "1"
	}, {
		"field": "device",
		"value": "1"
	}]
}

返回数据示例

{
  "errcode": 0,
  "errmsg": "ok",
  "data": {
      "body": {
          "tables": [
              {
                 "id": "memorydiff",
                 "lines": [
                      {
                          "fields": [
                              {
                                  "refdate": "20210103",
                                  "value": "70.7778"
                              },
                              {
                                  "refdate": "20210104",
                                  "value": "72.0446"
                              }
                          ]
                      }
                  ],
                  "zh": "内存增长均值"
              },
              {
                  "id": "memory",
                  "lines": [
                      {
                          "fields": [
                              {
                                  "refdate": "20210103",
                                  "value": "314"
                              },
                              {
                                  "refdate": "20210104",
                                  "value": "302.3218"
                              }
                          ]
                      }
                  ],
                  "zh": "内存均值"
              }
          ],
          "count": 2
      }
  }
}

云调用

云调用是微信云开发提供的在云函数中调用微信开放接口的能力,需要在云函数中通过 wx-server-sdk 使用。

接口方法

openapi.analysis.getPerformanceData

需在 config.json 中配置 analysis.getPerformanceData API 的权限,详情

请求参数

属性 类型 默认值 必填 说明
time Object 开始和结束日期的时间戳,时间跨度不能超过30天
module string 查询数据的类型
params Object 查询条件,比如机型,网络类型等等

time 的结构

属性 类型 默认值 必填 说明
endTimestamp string 结束日期时间戳
beginTimestamp string 开始日期时间戳

module 的合法值

说明 最低版本
10016 打开率, params字段可传入网络类型和机型
10017 启动各阶段耗时,params字段可传入网络类型和机型
10021 页面切换耗时,params数组字段可传入机型
10022 内存指标,params数组字段可传入机型
10023 内存异常,params数组字段可传入机型

params 的结构

属性 类型 默认值 必填 说明
field string 查询条件
value string 查询条件值

field 的合法值

说明 最低版本
networktype 网络类型作为查询条件,value=“-1,3g,4g,wifi”分别表示 全部网络类型,3G,4G,WIFI,不传networktype默认为全部网络类型
device_level 机型作为查询条件,此时value=“-1,1,2,3”分别表示 全部机型,高档机,中档机,低档机,不传device_level默认为全部机型
device 平台作为查询条件,此时value="-1,1,2"分别表示 全部平台,IOS平台,安卓平台,不传device默认为全部平台

返回值

Object

返回的 JSON 数据包

属性 类型 说明
errCode number 错误码
errMsg string 错误信息
body Object 返回的性能数据

body 的结构

属性 类型 说明
tables Object 返回的数据数组
count number 数组大小

tables 的结构

属性 类型 说明
id string 性能数据指标id
lines Object 按时间排列的性能数据
zh string 性能数据指标中文名

lines 的结构

属性 类型 说明
fields Object 单天的性能数据

fields 的结构

属性 类型 说明
refdate stirng 日期
value stirng 性能数据值

异常

Object

抛出的异常

属性 类型 说明
errCode number 错误码
errMsg string 错误信息

errCode 的合法值

说明 最低版本

请求数据示例

const cloud = require('wx-server-sdk')
cloud.init({
  env: cloud.DYNAMIC_CURRENT_ENV,
})
exports.main = async (event, context) => {
  try {
    const result = await cloud.openapi.analysis.getPerformanceData({
        "time": {
          "endTimestamp": 1609689600,
          "beginTimestamp": 1609603200
        },
        "module": '10022',
        "params": [
          {
            "field": 'networktype',
            "value": 'wifi'
          },
          {
            "field": 'device_level',
            "value": '1'
          },
          {
            "field": 'device',
            "value": '1'
          }
        ]
      })
    return result
  } catch (err) {
    return err
  }
}

返回数据示例

{
  "errCode": 0,
  "errMsg": "openapi.analysis.getPerformanceData:ok",
  "data": {
    "body": {
      "tables": [
        {
          "id": "memorydiff",
          "lines": [
            {
              "fields": [
                {
                  "refdate": "20210103",
                  "value": "70.7778"
                },
                {
                  "refdate": "20210104",
                  "value": "72.0446"
                }
              ]
            }
          ],
          "zh": "内存增长均值"
        },
        {
          "id": "memory",
          "lines": [
            {
              "fields": [
                {
                  "refdate": "20210103",
                  "value": "314"
                },
                {
                  "refdate": "20210104",
                  "value": "302.3218"
                }
              ]
            }
          ],
          "zh": "内存均值"
        }
      ],
      "count": 2
    }
  }
}