# 获取小程序性能数据

接口应在服务器端调用，不可在前端（小程序、网页、APP等）直接调用，具体可参考接口调用指南

接口英文名：getPerformanceData

该接口用于获取小程序启动性能，运行性能等数据

# 1. 调用方式

# HTTPS 调用

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

支持加密请求： 本接口支持服务通信二次加密和签名，可有效防止数据篡改与泄露。查看详情

# 云调用

本接口不支持云调用

# 第三方调用

本接口支持第三方平台代商家调用。
该接口所属的权限集 id 为：18
服务商获得其中之一权限集授权后，可通过使用 authorizer_access_token 代商家进行调用，具体可查看第三方调用说明文档。

# 2. 请求参数

# 查询参数 `Query String parameters`

参数名	类型	必填	说明
access_token	string	是	接口调用凭证，可使用 access_token、authorizer_access_token

# 请求体 `Request Payload`

参数名	类型	必填	说明
module	number	是	查询数据的类型
time	object	是	开始和结束日期的时间戳，时间跨度不能超过30天
params	objarray	是	查询条件，比如机型，网络类型等等

# Body.time `Object Payload`

开始和结束日期的时间戳，时间跨度不能超过30天

参数名	类型	必填	说明
begin_timestamp	number	是	开始日期时间戳
end_timestamp	number	是	结束日期时间戳

# Body.params(Array) `Object Payload`

查询条件，比如机型，网络类型等等

参数名	类型	必填	说明
field	string	是	查询条件
value	string	是	查询条件值

# 3. 返回参数

# 返回体 `Response Payload`

参数名	类型	说明
errcode	number	错误码
errmsg	string	错误信息
data	object	返回的性能数据

# Res.data `Object Payload`

返回的性能数据

参数名	类型	说明
body	object	返回的性能数据

# Res.data.body `Object Payload`

返回的性能数据

参数名	类型	说明
tables	objarray	返回的数据数组
count	number	数组大小

# Res.data.body.tables(Array) `Object Payload`

返回的数据数组

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

# Res.data.body.tables(Array).lines`Object Payload`

按时间排列的性能数据

参数名	类型	说明
fields	objarray	单天的性能数据

# Res.data.body.tables(Array).lines.fields`Object Payload`

单天的性能数据

参数名	类型	说明
refdate	string	日期
value	string	性能数据值

# 4. 注意事项

# 其他说明

# module 的合法值

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

# 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默认为全部平台

# 5. 代码示例

# 5.1 HTTPS调用

请求示例

{
  "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
    }
  }
}

# 5.2 云函数调用

请求示例

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
    }
  }
}

# 6. 错误码

以下是本接口的错误码列表，其他错误码可参考通用错误码；调用接口遇到报错，可使用官方提供的 API 诊断工具辅助定位和分析问题。

错误码	错误描述	解决方案
40001	invalid credential access_token isinvalid or not latest	获取 access_token 时 AppSecret 错误，或者 access_token 无效。请开发者认真比对 AppSecret 的正确性，或查看是否正在为恰当的公众号调用接口

# 7. 适用范围

本接口在不同账号类型下的可调用情况：

小程序	小游戏
✔	✔

✔：该账号可调用此接口
其他未明确声明的账号类型，如无特殊说明，均不可调用此接口；