Skip to content

说明

调用方式

  1. 获取授权码(X-Auth-Key)和账号Id(accountId)

步骤一

步骤二

如果账号没有生成授权码,请点击重新生成授权码生成 步骤三 2. 请求接口

参考示例(curl):

Content-Type: application/x-www-form-urlencoded:

curl --request POST \
  --url https://report.tingyun.com/mp-api/auth/app/list \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --header 'X-Auth-Key: [授权码]' \
  --data 'accountId=[账号ID]'

Content-Type: application/json:

curl --request POST \
  --url https://report.tingyun.com/mp-api/auth/abnormal/slowpage/list \
  --header 'Content-Type: application/json' \
  --header 'X-Auth-Key: [授权码]' \
  --data '{"mpId": 16,"timePeriod": 10080,"path": "pages/book/book","endTime": "2019-01-17 17:08", "accountId": [账号ID]}'

接口默认Content-Type为application/x-www-form-urlencoded, 需要指定application/json时会在相应接口处说明

  • 接口根路径:
https://report.tingyun.com/mp-api/auth

注意: 接口文档中的接口路径与报表一致,在调用API时,需要在所有api前添加/auth/路径前缀(即根路径 + API路径), 否则无法通过校验

返回结果说明

API 返回格统一格式

{
    "code": 业务状态码具体参考列表 (Number),
    "msg": 信息 (String),
    "data": 数据 (Object或Array)
}

接口文档中展示的结果描述的是data 中的返回结构

code(业务状态码)列表

内容 状态码
200 成功
400 请求参数不合法
500 服务端错误
1001 应用名称重复
1002 应用名称为空
1003 用户数据获取为空

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
打开次数 ov
网络请求响应时间 responseTime ms
网络请求错误率 netErrorRate %
js错误率 jsErrorRate %
JS错误(类型文件名)占比 jsFileErrorRatio %
JS错误页面PV jsErrorPv
总耗时占比(网络请求) durationRatio %
请求次数(网络请求) netCount
慢(页面)占比 slowPageRatio %
慢(网络请求)占比 slowNetRatio %
服务端响应时间 applicationServerTime ms
传输数据量 transmission kb
上传 bytesSent kb
下载 bytesReceived kb
回调时间 callbackTime ms
网络耗时 networkTime ms
自定义指标时间 customTime ms
页面退出率 pageQuitRate %

请求数据说明

如何获取小程序应用id

调用接口:

https://report.tingyun.com/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