Overview

Calling method

The interface path in the interface document is consistent with the console. When calling the API, you need to add the path prefix /mp-api/auth/ (that is, the root path + API path) before all APIs, otherwise the verification will fail.

The interface root path is:

https://${domain name}/mp-api/auth

Return result description

API return unified format

{
  "code": business status code, refer to the list for details (Number),
  "msg": information (String),
  "data": data (Object or Array)
}

**The results shown in the interface document describe the return structure in data. **

Highcharts chart general return results

{
    "overview": {},
    "series": [
        {
            "data": [
                {
                    "x": 1545207960000,
                    "y": 3,
                    "tooltip": "{\"title\":\"12-19 16:26--12-19 19:26\",\"data\":[{\"title\":\"open times\",\"value\":3.0,\"unit\":\"times\"}]}"
                },
                ...
            ],
            "name": "demo1",
            "params": "{\"mpId\":46}",
            "type": "area",
            "yAxis": 0
        }
    ],
    "yAxis": [
        {
            "tickUnit": "times"
        }
    ]
}

Indicator list

Baseon and returned API names are subject to the table regulations.

Indicator name	baseon(API) name	unit
User experience score	uxScore
onReady	onReadyTime	ms
First response time	firstResponseTime	ms
UV	uv	times
PV	pv	times
Slow page	slowCount	times
Slow page ratio	slowPageRatio	%
Custom indicator time	customTime	ms
Total page exit rate	quitRate	%
Open times	ov	times
Number of requests	netCount	times
Number of slow requests	netSlowCount	times
Number of error requests	netErrorCount	times
Request duration	responseTime	ms
Request error rate	netErrorRate	%
Total duration ratio (network request)	durationRatio	%
Slow ratio Ratio (network request)	slowNetRatio	%
Time consumed by the server	applicationServerTime	ms
Data volume transmitted	transmission	kb
Upload	bytesSent	kb
Download	bytesReceived	kb
Callback time	callbackTime	ms
Network time consumed	networkTime	ms
Business availability	netBizAvailable	%
js error rate	jsErrorRate	%
JS error type PV (error PV)	errorPv	times
JS error type ratio	errorRatio	%
Number of API calls	apiCallCount	times
Number of API successes	apiSuccessCount	times
Number of API failures	apiFailCount	times
Number of API cancellations	apiCancelCount	times
API call success rate	apiSuccessRate	%
Number of users who failed to call	apiFailUserCount	times
API Number of users affected by the call	apiInfluenceUserCount	times
Number of operations	operaCount	times
Number of failed operations	operaFailCount	times
Number of successful operations	operaSuccessCount	times
Number of slow operations	operaSlowCount	times
Number of operation requests	operRequestCount	times
Operation availability	operaAvailableRate	%
Operation time	operaTime	ms
Operation request time	operRequestTime	ms
Average time consumed by the operation server	operaServerTime	ms
Loading time	firstLoadTime	ms
Stuck PV	stuckCount	times
Stuck rate	stuckRate	%
Online time	onlineTime	ms
Page abnormality rate	exRate	%
Abnormal exit rate	exQuitRate	%

Request data description

How to get the mini program application id

Call interface:

https://${domain}/mp-api/auth/app/select-list

Users can view the corresponding mini program id according to the name.

Region-related id list

Country

Country	id
China	48
United States	225
Russia	185
France	74
United Kingdom	77
Japan	111
India	103

Region (China)

Province	id
Beijing	4811
Tianjin	4812
Hebei	4813
Shanxi	4814
Inner Mongolia	4815
Liaoning	4821
Jilin	4822
Heilongjiang	4823
Shanghai	4831
Jiangsu	4832
Zhejiang	4833
Anhui	4834
Fujian	4835
Jiangxi	4836
Shandong	4837
Henan	4 841
Hubei	4842
Hunan	4843
Guangdong	4844
Guangxi	4845
Hainan	4846
Chongqing	4850
Sichuan	4851
Guizhou	4852
Yunnan	4853
Tibet	4854
Shaanxi	4861
Gansu	4862
Qinghai	4863
Ningxia	4864
Xinjiang	4865
Taiwan	4871
Hong Kong	4881
Macao	4882