概述
调用方式
接口文档中的接口路径与控制台一致，在调用API时，需要在所有API前添加/mp-api/auth/路径前缀（即根路径 + API路径），否则无法通过校验。
接口根路径为：
https://${域名}/mp-api/auth
返回结果说明
API 返回统一格式
{
"code": 业务状态码，具体参考列表 (Number),
"msg": 信息 (String),
"data": 数据 (Object或Array)
}
接口文档中展示的 结果描述的是data中的返回结构。
Highcharts图通用返回结果
{
"overview": {},
"series": [
{
"data": [
{
"x": 1545207960000,
"y": 3,
"tooltip": "{\"title\":\"12-19 16:26--12-19 19:26\",\"data\":[{\"title\":\"打开次数\",\"value\":3.0,\"unit\":\"次\"}]}"
},
...
],
"name": "demo1",
"params": "{\"mpId\":46}",
"type": "area",
"yAxis": 0
}
],
"yAxis": [
{
"tickUnit": "次"
}
]
}
指标列表
baseon和返回API名称都以表格规定为准。
| 指标名称 | baseon(API)名称 | 单位 |
|---|---|---|
| 用户体验评分 | uxScore | |
| onReady | onReadyTime | ms |
| 首次响应时间 | firstResponseTime | ms |
| UV | uv | 次 |
| PV | pv | 次 |
| 慢页面 | slowCount | 次 |
| 慢页面占比 | slowPageRatio | % |
| 自定义指标时间 | customTime | ms |
| 页面总退出率 | quitRate | % |
| 打开次数 | ov | 次 |
| 请求次数 | netCount | 次 |
| 慢请求次数 | netSlowCount | 次 |
| 错误请求次数 | netErrorCount | 次 |
| 请求耗时 | responseTime | ms |
| 请求错误率 | netErrorRate | % |
| 总耗时占比(网络请求) | durationRatio | % |
| 慢占比(网络请求) | slowNetRatio | % |
| 服务端耗时 | applicationServerTime | ms |
| 传输数据量 | transmission | kb |
| 上传 | bytesSent | kb |
| 下载 | bytesReceived | kb |
| 回调时间 | callbackTime | ms |
| 网络耗时 | networkTime | ms |
| 业务可用性 | netBizAvailable | % |
| js错误率 | jsErrorRate | % |
| JS错误类型PV(错误PV) | errorPv | 次 |
| JS错误类型占比 | errorRatio | % |
| API调用次数 | apiCallCount | 次 |
| API成功次数 | apiSuccessCount | 次 |
| API失败次数 | apiFailCount | 次 |
| API取消次数 | apiCancelCount | 次 |
| API 调用成功率 | apiSuccessRate | % |
| API 调用失败用户数 | apiFailUserCount | 次 |
| API 调用影响用户数 | apiInfluenceUserCount | 次 |
| 操作次数 | operaCount | 次 |
| 失败操作次数 | operaFailCount | 次 |
| 成功操作次数 | operaSuccessCount | 次 |
| 慢操作次数 | operaSlowCount | 次 |
| 操作请求次数 | operaRequestCount | 次 |
| 操作可用性 | operaAvailableRate | % |
| 操作时间 | operaTime | ms |
| 操作请求耗时 | operaRequestTime | ms |
| 操作服务端平均耗时 | operaServerTime | ms |
| 加载耗时 | firstLoadTime | ms |
| 卡顿PV | stuckCount | 次 |
| 卡顿率 | stuckRate | % |
| 在线时长 | onlineTime | ms |
| 页面异常率 | exRate | % |
| 异常退出率 | exQuitRate | % |
请求数据说明
如何获取小程序应用id
调用接口:
https://${域名}/mp-api/auth/app/select-list
用户可根据名称查看对应的小程序id。
地域相关id列表
国家
| 国家 | id |
|---|---|
| 中国 | 48 |
| 美国 | 225 |
| 俄罗斯 | 185 |
| 法国 | 74 |
| 英国 | 77 |
| 日本 | 111 |
| 印度 | 103 |
区域（中国）
| 省份 | id |
|---|---|
| 北京 | 4811 |
| 天津 | 4812 |
| 河北 | 4813 |
| 山西 | 4814 |
| 内蒙古 | 4815 |
| 辽宁 | 4821 |
| 吉林 | 4822 |
| 黑龙江 | 4823 |
| 上海 | 4831 |
| 江苏 | 4832 |
| 浙江 | 4833 |
| 安徽 | 4834 |
| 福建 | 4835 |
| 江西 | 4836 |
| 山东 | 4837 |
| 河南 | 4841 |
| 湖北 | 4842 |
| 湖南 | 4843 |
| 广东 | 4844 |
| 广西 | 4845 |
| 海南 | 4846 |
| 重庆 | 4850 |
| 四川 | 4851 |
| 贵州 | 4852 |
| 云南 | 4853 |
| 西藏 | 4854 |
| 陕西 | 4861 |
| 甘肃 | 4862 |
| 青海 | 4863 |
| 宁夏 | 4864 |
| 新疆 | 4865 |
| 台湾 | 4871 |
| 香港 | 4881 |
| 澳门 | 4882 |