应用概览

概览信息

小程序列表

POST /app/list

请求参数	类型	必选参数	说明
timePeriod	Number	否	参数为默认为30分钟
endTime	String	否	截止时间格式yyyy-MM-dd HH:mm 例如(2018-02-07 17:39)
orderBy	String	否	排序指标名称, 指标名称见列表
orderType	String	否	asc: 正序， desc：倒序不传按默认(正序)

返回结果:

{
        "overview": {
            "badNum": 1,
            "normalNum": 0,
            "alarmNum": 0,
            "goodNum": 0
        },
        "list": [
            {
                "uxScore": 37,
                "pv": 3705,
                "applicationServerTime": 20,
                "uv": 3.0,
                "jsErrorRate": 100.0,
                "netErrorRate": 100.0,
                "responseTime": 82.0,
                "networkTime": 39.0,
                "onReadyTime": 1529.0,
                "firstResponseTime": 1530.0,
                "firstLoadTime": 1000, // 加载耗时
                "stuckRate": 20.12, // 卡顿率
                "mpId": 46,
                "name": "demo1",
                "status": 1,
                "alarmStatus": -1,
                "noData": false,
                "type": "bad",
                "hasServer": true
            },
            {
                "mpId": 52,
                "name": "博客园",
                "status": 1,
                "alarmStatus": -1,
                "noData": true,
                "type": "nodata",
                "hasServer": true
            }
        ]
    }

查询小程序关联的server应用列表

POST /app/server-list

请求参数	类型	必选参数	说明
mpId	Number	是	小程序应用ID
timePeriod	Number	否	时间段，没有查最近30分钟
endTime	String	否

[ {
    "id" : 143947,
    "name" : "xxx",
    "responseTime" : 0,
    "rpm" : 3345.3333,
    "errorRate" : "0.0000"
  },
  ...]

小程序应用下拉列表

POST /app/select-list

说明:

指定时间段内合同号下的小程序列表

请求参数	类型	必选参数	说明
timePeriod	Number	否	参数为默认为30分钟
endTime	String	否	截止时间格式yyyy-MM-dd HH:mm 例如(2018-02-07 17:39)

[{
    "id": 1138025411,
    "name": "小程序测试1",
    "hasData": true
},
...]

打开次数图

POST /chart/app-ov

请求参数	类型	必选参数	说明
timePeriod	Number	否	参数为默认为30分钟
endTime	String	否	截止时间格式yyyy-MM-dd HH:mm 例如(2018-02-07 17:39)

{
    "overview": {
        "data": [
            {
                "id": 36,
                "name": "testapp",
                "openCount": 62 //应用打开次数
            }
        ],
        "aggregateValue": 62 // 总打开次数
    },
    // 以下为Highcharts返回结果
    "series": [
        {
            "data": [
                {
                    "x": 1545101580000,
                    "y": 14,
                    "tooltip": "{\"title\":\"12-18 10:53--12-18 16:53\",\"data\":[{\"title\":\"打开次数\",\"value\":14.0,\"unit\":\"次\"}]}"
                },
                ...
            ],
            "name": "maoyan",
            "params": "{\"mpId\":36}",
            "type": "area",
            "yAxis": 0
        },
    ],
    "yAxis": [
        {
            "tickUnit": "次"
        }
    ]
}

应用详情

用户体验评分雷达图

POST /app/ux-radar

请求参数	类型	必选参数	说明
mpId	Number	是	小程序id
timePeriod	Number	否	参数为默认为30分钟
endTime	String	否	截止时间格式yyyy-MM-dd HH:mm 例如(2018-02-07 17:39)

返回结果：

{
    "value": 82, //综合总分
    "overview"
    },
    "indicator": [
        {
            "name": "操作可用性",
            "max": 100
        },
        {
            "name": "首次加载",
            "max": 100
        },
        {
            "name": "请求错误率",
            "max": 100
        },
        {
            "name": "onReady",
            "max": 100
        },
        {
            "name": "请求耗时",
            "max": 100
        },
        {
            "name": "JS错误率",
            "max": 100
        },
        {
            "name": "卡顿率",
            "max": 100
        }
    ],
    "series": [
        {
            "name": "评分",
            "value": [
                89,
                90,
                99,
                96,
                97,
                90,
                90
            ]
        }
    ]
}

性能卡片

POST /app/performance-card

说明：

每个卡片调用一次, 前端分多次请求数据, 具体baseon指标名称参考指标名称文档

根据不同的指标出曲线图和概览指标

请求参数	类型	必选参数	说明
mpId	Number	是	小程序id
timePeriod	Number	否	参数为默认为30分钟
endTime	String	否	截止时间格式yyyy-MM-dd HH:mm 例如(2018-02-07 17:39)
baseon	String	是	性能指标名称
path	String	否	路径
host	String	否	host
uri	String	否	uri
countryId	Number	否	国家Id
regionId	Number	否	地域Id
carrierId	Number	否	运营商
cityId	Number	否	城市
networkType	String	否	网络类型
disablePeek	Number	否	是否不计算峰值,传1不计算
disableAggr	Number	否	是否不计算均值,传1不计算
disableMomyoy	Number	否	是否不计算同比环比,传1不计算

返回结果：

{
    "overview": {
        "value": 2000, //聚合值(对于PV 是总和，其他指标为均值)
        "max": 4000, //峰值(不需要峰值的指标，此字段不返回)
        "unit": "" //值的单位
    },
    "series": [
        {
            "data": [
                {
                    "x": 1515686400000,
                    "y": 0.146,
                    "title": "{"title":"02-08 15:28--02-08 15:30","data":[{"title":"指标","value":"10","unit":"次"}]}"
                },...
            ],
            "name": "pv",
            "yAxis": 0 //指定series使用的y轴
        }
    ],
    "yAxis": [
        {
            "tickUnit": "pv"
        },
        ...
    ]
}

指标趋势图

POST /app/performance-card

说明

此图使用上边的性能卡片接口, 根据选择的指标返回结果

请求参数	类型	必选参数	说明
mpId	Number	是	小程序id
timePeriod	Number	否	参数为默认为30分钟
endTime	String	否	截止时间格式yyyy-MM-dd HH:mm 例如(2018-02-07 17:39)
baseon	String	是	性能指标名称
disablePeek	Number	否	是否计算峰值，对于此图，不需要计算, 传1

Top5关键页面

POST /app/keypage-top

请求参数	类型	必选参数	说明
mpId	Number	是	小程序id
timePeriod	Number	否	参数为默认为30分钟
endTime	String	否	截止时间格式yyyy-MM-dd HH:mm 例如(2018-02-07 17:39)
baseon	String	是	性能指标名称

返回结果:

{
    "list": [
        {
            "uxScore": 94,
            "pv": 64,
            "applicationServerTime": 40,
            "jsErrorRate": 0.0,
            "onReadyTime": 196.0,
            "firstResponseTime": 286.0,
            "path": "pages/movies/index",
            "alias": " 影院展示"
        }
    ],
    "series": [
        {
            "data": [
                {
                    "x": 1545102480000,
                    "y": 4E+1,
                    "tooltip": "{\"title\":\"12-18 11:08--12-18 17:08\",\"data\":[{\"title\":\"PV\",\"value\":40.0,\"unit\":\"次\"},{\"title\":\"性能评分\",\"value\":67.0,\"unit\":\"\"},{\"title\":\"onReady\",\"value\":43.0,\"unit\":\"ms\"},{\"title\":\"JS错误率\",\"value\":100.0,\"unit\":\"%\"},{\"title\":\"服务端响应时间\",\"value\":1729.0,\"unit\":\"ms\"},{\"title\":\"首次响应时间\",\"value\":300.0,\"unit\":\"ms\"}]}"
                },
                ...
            ],
            "name": "付款",
            "params": "{\"path\":\"付款\"}",
            "type": "line"
        },
        ...
    ],
    "yAxis": [
        {
            "tickUnit": "次"
        }
    ]
}

Top5关键请求

POST /app/keyrequest-top

请求参数	类型	必选参数	说明
mpId	Number	是	小程序id
timePeriod	Number	否	参数为默认为30分钟
endTime	String	否	截止时间格式yyyy-MM-dd HH:mm 例如(2018-02-07 17:39)
baseon	String	是	性能指标名称

返回结果:

{
    "list": [
        {
            "uxScore": 37,
            "pv": 3702,
            "applicationServerTime": 20,
            "jsErrorRate": 100.0,
            "onReadyTime": 1530.0,
            "firstResponseTime": 1530.0,
            "path": "pages/list/list7"
        }
    ],
    "series": [
        {
            "data": [
                {
                    "x": 1545208860000,
                    "y": 1332,
                    "tooltip": "{\"title\":\"12-19 16:41--12-19 19:41\",\"data\":[{\"title\":\"PV\",\"value\":1332.0,\"unit\":\"次\"},{\"title\":\"性能评分\",\"value\":37.0,\"unit\":\"\"},{\"title\":\"onReady\",\"value\":1534.0,\"unit\":\"ms\"},{\"title\":\"JS错误率\",\"value\":100.0,\"unit\":\"%\"},{\"title\":\"服务端响应时间\",\"value\":20.0,\"unit\":\"ms\"},{\"title\":\"首次响应时间\",\"value\":1534.0,\"unit\":\"ms\"}]}"
                },
                ...
            ],
            "name": "pages/list/list7",
            "params": "{\"path\":\"pages/list/list7\"}",
            "type": "line"
        }
    ],
    "yAxis": [
        {
            "tickUnit": "次"
        }
    ]
}

TOP5页面用户体验表格

POST /app/page-top-list

请求参数	类型	必选参数	说明
mpId	Number	是	小程序id
timePeriod	Number	否	参数为默认为30分钟
endTime	String	否	截止时间格式yyyy-MM-dd HH:mm 例如(2018-02-07 17:39)
baseon	String	是	性能指标名称

返回结果:

[
    {
        "uxScore": 33,
        "pv": 3,
        "applicationServerTime": 600,
        "uv": 1.0,
        "jsErrorRate": 100.0,
        "netErrorRate": 100.0,
        "responseTime": 1500.0,
        "onReadyTime": 250.0,
        "firstResponseTime": 1750.0,
        "path": "pages/test/test"
    },
    ...
]

TOP5页面用户体验右侧图

POST /chart/page-performance

说明:

此图与页面上方第一张图接口相同

请求参数	类型	必选参数	说明
mpId	Number	是	小程序id
path	String	是	页面路径
timePeriod	Number	否	参数为默认为30分钟
endTime	String	否	截止时间格式yyyy-MM-dd HH:mm 例如(2018-02-07 17:39)

返回结果: Highcharts图通用返回结果

TOP5网络请求表格

POST /app/request-top-list

请求参数	类型	必选参数	说明
mpId	Number	是	小程序id
timePeriod	Number	否	参数为默认为30分钟
endTime	String	否	截止时间格式yyyy-MM-dd HH:mm 例如(2018-02-07 17:39)

返回结果:

[
    {
        "uxScore": 78,
        "netCount": 3,
        "applicationServerTime": 600,
        "uv": 1.0,
        "jsErrorRate": 0.0,
        "netErrorRate": 100.0,
        "responseTime": 1500.0,
        "host": "www.google.com",
        "uri": "/sense-api/metric/*.json",
        "ajaxErrorCount": 0.0,
        "slowRatio": 0.0
    },
    ...
]

TOP5网络请求右侧图

POST /chart/net-request-trend

说明:

此图查看网络请求API, 相同图

地图组件

运营商列表

参考地域模块接口

网络请求列表

参考地域模块接口

地域地图

参考地域模块地图接口

地域列表

POST /app/region-list

请求参数	类型	必选参数	说明
mpId	Number	是	小程序id
path	String	否	页面路由路径
timePeriod	Number	否	参数为默认为30分钟
endTime	String	否	截止时间格式yyyy-MM-dd HH:mm 例如(2018-02-07 17:39)
baseon	String	是	指标名称
regionType	String	是	可选值 country(查询国家下的省份) , region(查询省份下的城市)
carrieId	Number	否	如果选择了运营商, 传运营商Id, 没选不传
networkType	String	否	如果选择了网络环境, 传网络环境字符串, 没选不传

返回结果:

[
    {
        "name": "北京市",
        "value": 167
    },
    ...
]

地域运营商分组图

POST /region/chart/region-carrier-network-group

说明: 传countryId : 按国家下的省份(regionId分组), 传regionId按国家下的城市分组, 不传按国家分组此外如果没传固定的运营商和网络环境, 也要按这两个分组, 如果某一个传了限制条件，按剩余条件分组。

查询指标(具体baseon传值参见api说明文档):
onReady
首次响应
自定义指标
网络耗时
网络请求响应时间
服务端响应时间
网络请求错误率
JS错误率, 自定义指标

请求参数	类型	必选参数	说明
mpId	Number	是	小程序id
path	String	否	路径
host	String	否	host
uri	String	否	uri
countryId	Number	否	国家Id
regionId	Number	否	地域Id
carrierId	Number	否	运营商
cityId	Number	否	城市
networkType	String	否	网络类型
timePeriod	Number	否	参数为默认为30分钟
endTime	String	否	截止时间格式yyyy-MM-dd HH:mm 例如(2018-02-07 17:39)

返回结果: Highcharts图通用返回结果

应用概览

概览信息​

小程序列表​

查询小程序关联的server应用列表​

小程序应用下拉列表​

打开次数图​

应用详情​

用户体验评分雷达图​

性能卡片​

指标趋势图​

Top5关键页面​

Top5关键请求​

TOP5页面用户体验 表格​

TOP5页面用户体验 右侧图​

TOP5网络请求 表格​

TOP5网络请求 右侧图​

地图组件​

运营商列表​

网络请求列表​

地域地图​

地域列表​

地域运营商分组图​

概览信息

小程序列表

查询小程序关联的server应用列表

小程序应用下拉列表

打开次数图

应用详情

用户体验评分雷达图

性能卡片

指标趋势图

Top5关键页面

Top5关键请求

TOP5页面用户体验表格

TOP5页面用户体验右侧图

TOP5网络请求表格

TOP5网络请求右侧图

地图组件

运营商列表

网络请求列表

地域地图

地域列表

地域运营商分组图