Application Overview

Overview Information

Mini Program List

POST /app/list

Request Parameters	Type	Required Parameters	Description
timePeriod	Number	No	Parameter defaults to 30 minutes
endTime	String	No	End Time Format yyyy-MM-dd HH:mm For example (2018-02-07 17:39)
orderBy	String	No	Sorting indicator name, see the list for indicator name
orderType	String	No	asc: positive order, desc: reverse order. If not passed, default (positive order) will be used

Return Result:

{
        "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, // Loading time
                "stuckRate": 20.12, // Stuck rate
                "mpId": 46,
                "name": "demo1",
                "status": 1,
                "alarmStatus": -1,
                "noData": false,
                "type": "bad",
                "hasServer": true
            },
            {
                "mpId": 52,
                "name": "Blog Garden",
                "status": 1,
                "alarmStatus": -1,
                "noData": true,
                "type": "nodata",
                "hasServer": true
            }
        ]
    }

Query the server application list associated with the mini program

POST /app/server-list

Request parameter	Type	Required parameter	Description
mpId	Number	Yes	Mini program application ID
timePeriod	Number	No	Time period, not querying the last 30 minutes
endTime	String	No

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

Mini program application drop-down list

POST /app/select-list

Description:

Within the specified time period Mini Program List under Contract Number

Request Parameter	Type	Required Parameter	Description
timePeriod	Number	No	Parameter is 30 minutes by default
endTime	String	No	Deadline Format yyyy-MM-dd HH:mm For example (2018-02-07 17:39)

[{
   "id": 1138025411,
   "name": "Mini Program Test 1",
   "hasData": true
},
...]

Open Times Chart

POST /chart/app-ov

Request Parameter	Type	Required Parameter	Description
timePeriod	Number	No	Parameter is 30 minutes by default
endTime	String	No	Deadline Format yyyy-MM-dd HH:mm For example (2018-02-07 17:39)

{
    "overview": {
        "data": [
            {
                "id": 36,
                "name": "testapp",
                "openCount": 62 //Number of times the application is opened
            }
        ],
        "aggregateValue": 62 // Total number of times it is opened
    },
    // The following is the result returned by Highcharts
    "series": [
        {
            "data": [
                {
                    "x": 1545101580000,
                    "y": 14,
                    "tooltip": "{\"title\":\"12-18 10:53--12-18 16:53\",\"data\":[{\"title\":\"open count\",\"value\":14.0,\"unit\":\"count\"}]}"
                },
                ...
            ],
            "name": "maoyan",
            "params": "{\"mpId\":36}",
            "type": "area",
            "yAxis": 0
        },
    ],
    "yAxis": [
        {
            "tickUnit": "count"
        }
    ]
}

Application details

User experience score radar chart

POST /app/ux-radar

Request parameter	Type	Required parameter	Description
mpId	Number	Yes	Mini program id
timePeriod	Number	No	Parameter default is 30 minutes
endTime	String	No	Deadline format yyyy-MM-dd HH:mm For example (2018-02-07 17:39)

Return result:

{
    "value": 82, //Comprehensive total score
    "overview"
    },
    "indicator": [
        {
            "name": "Operation availability",
            "max": 100
        },
        {
            "name": "First load",
            "max": 100
        },
        {
            "name": "Request error rate",
            "max": 100
        },
        {
            "name": "onReady",
            "max": 100
        },
        {
            "name": "Request time",
            "max": 100
        },
        {
            "name": "JS error rate",
            "max": 100
        },
        {
            "name": "Stuttering rate",
            "max": 100
        }
    ],
    "series": [
        {
            "name": "Rating",
            "value": [
                89,
                90,
                99,
                96,
                97,
                90,
                90
            ]
        }
    ]
}

Performance card

POST /app/performance-card

Description:

Each card is called once, and the front end requests data multiple times. For the specific baseon indicator name, refer to the indicator name document

Produce curves and overview indicators based on different indicators

Request parameter	Type	Required parameter	Description
mpId	Number	Yes	Mini program id
timePeriod	Number	No	Parameter default is 30 minutes
endTime	String	No	End time format yyyy-MM-dd HH:mm For example (2018-02-07 17:39)
baseon	String	Yes	Performance indicator name
path	String	No	Path
host	String	No	host
uri	String	No	uri
countryId	Number	No	Country Id
regionId	Number	No	Region Id
carrierId	Number	No	Carrier
cityId	Number	No	City
networkType	String	No	Network type
disablePeek	Number	No	Whether to not calculate the peak value, pass 1 to not calculate
disableAggr	Number	No	Whether to not calculate the average value, pass 1 to not calculate
disableMomyoy	Number	No	Whether to not calculate the year-on-year and month-on-month, pass 1 to not calculate

Return result:

{
    "overview": {
        "value": 2000, //Aggregation value (for PV, it is the sum, and for other indicators, it is the mean)
        "max": 4000, //Peak value (this field is not returned if the peak value is not required)
        "unit": "" //Unit of value
    },
    "series": [
        {
            "data": [
                {
                    "x": 1515686400000,
                    "y": 0.146,
                    "title": "{"title":"02-08 15:28--02-08 15:30","data":[{"title":"metric","value":"10","unit":"count"}]}"
                },...
            ],
            "name": "pv",
            "yAxis": 0 //Specify the y axis used by the series
        }
    ],
    "yAxis": [
        {
            "tickUnit": "pv"
        },
        ...
    ]
}

Indicator trend chart

POST /app/performance-card

Description

This chart uses the performance card interface above and returns results based on the selected indicator

Request parameter	Type	Required parameter	Description
mpId	Number	Yes	Mini program id
timePeriod	Number	No	Parameter defaults to 30 minutes
endTime	String	No	End time format yyyy-MM-dd HH:mm For example (2018-02-07 17:39)
baseon	String	Yes	Performance indicator name
disablePeek	Number	No	Whether to calculate the peak value, no calculation is required for this chart, pass 1

Top5 key pages

POST /app/keypage-top

Request parameter	Type	Required parameter	Description
mpId	Number	Yes	Mini program id
timePeriod	Number	No	Parameter default is 30 minutes
endTime	String	No	End time format yyyy-MM-dd HH:mm For example (2018-02-07 17:39)
baseon	String	Yes	Performance indicator name

Return result:

{
    "list": [
        {
            "uxScore": 94,
            "pv": 64,
            "applicationServerTime": 40,
            "jsErrorRate": 0.0,
            "onReadyTime": 196.0,
            "firstResponseTime": 286.0,
            "path": "pages/movies/index",
            "alias": " Movie theater display"
        }
    ],
    "series": [
        {
            "data": [
                {
                    "x": 1545102480000,
                    "y": 4E+1,
                    "tooltip": "{\"title\":\"12-18 11:08--12-18 17:08\",\"data\":[{\"title\":\"PV\",\"value\":40.0,\"unit\":\"times\"},{\"title\":\"Performance score\",\"value\":67.0,\"unit\":\"\"},{\"title\":\"onReady\",\"value\":43.0,\"unit\":\"ms\"},{\"title\":\"JS error rate\",\"value\":100.0,\"unit\":\"%\"},{\"title\":\"Server response time\",\"value\":1729.0,\"unit\":\"ms\"},{\"title\":\"First response time\",\"value\":300.0,\"unit\":\"ms\"}]}"
                },
                ...
            ],
            "name": "Payment",
            "params": "{\"path\":\"Payment\"}",
            "type": "line"
        },
        ...
    ],
    "yAxis": [
        {
            "tickUnit": "times"
        }
    ]
}

Top5 key requests

POST /app/keyrequest-top

Request parameters	Type	Required parameters	Description
mpId	Number	Yes	Mini program id
timePeriod	Number	No	Parameter default is 30 minutes
endTime	String	No	End time format yyyy-MM-dd HH:mm For example (2018-02-07 17:39)
baseon	String	Yes	Performance indicator name

Return result:

{
    "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\":\"times\"},{\"title\":\"Performance score\",\"value\":37.0,\"unit\":\"\"},{\"title\":\"onReady\",\"value\":1534.0,\"unit\":\"ms\"},{\"title\":\"JS error rate\",\"value\":100.0,\"unit\":\"%\"},{\"title\":\"Server response time\",\"value\":20.0,\"unit\":\"ms\"},{\"title\":\"First response time\",\"value\":1534.0,\"unit\":\"ms\"}]}"
                },
                ...
            ],
            "name": "pages/list/list7",
            "params": "{\"path\":\"pages/list/list7\"}",
            "type": "line"
        }
    ],
    "yAxis": [
        {
            "tickUnit": "times"
        }
    ]
}

TOP5 page user experience table

POST /app/page-top-list

Request parameter	Type	Required parameter	Description
mpId	Number	Yes	Mini program id
timePeriod	Number	No	Parameter default is 30 minutes
endTime	String	No	End time format yyyy-MM-dd HH:mm For example (2018-02-07 17:39)
baseon	String	Yes	Performance indicator name

Return result:

[
    {
        "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 page user experience right side picture

POST /chart/page-performance

Description:

This picture has the same interface as the first picture on the top of the page

Request parameter	Type	Required parameter	Description
mpId	Number	Yes	Mini program id
path	String	Yes	Page path
timePeriod	Number	No	Parameter default is 30 minutes
endTime	String	No	Deadline format yyyy-MM-dd HH:mm For example (2018-02-07 17:39)

Return result: Highcharts chart general return result

TOP5 network request table

POST /app/request-top-list

Request parameter	Type	Required parameter	Description
mpId	Number	Yes	Mini program id
timePeriod	Number	No	Parameter default is 30 minutes
endTime	String	No	End time format yyyy-MM-dd HH:mm For example (2018-02-07 17:39)

Return result:

[
    {
        "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 network requests Right side graph

POST /chart/net-request-trend

Description:

This graph shows the network request API, same graph

Map component

Operator list

Reference region module interface

Network request list

Reference region module interface

Region map

Reference region module map interface

Region list

POST /app/region-list

Request parameter	Type	Required parameter	Description
mpId	Number	Yes	Mini program id
path	String	No	Page routing path
timePeriod	Number	No	Parameter defaults to 30 minutes
endTime	String	No	End time format yyyy-MM-dd HH:mm For example (2018-02-07 17:39)
baseon	String	Yes	Indicator name
regionType	String	Yes	Optional value country (query the province under the country), region (query cities under provinces)
carrieId	Number	No	If a carrier is selected, pass the carrier ID, otherwise do not pass
networkType	String	No	If a network environment is selected, pass the network environment string, otherwise do not pass

Return result:

[
    {
        "name": "Beijing",
        "value": 167
    },
    ...
]

Regional carrier grouping chart

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

Description: Pass countryId: group by province under country (regionId), pass regionId to group by city under country, do not pass to group by country In addition, if no fixed carrier and network environment are passed, these two groups are also used. If one of them has a restriction condition, the remaining conditions are used for grouping.

Query indicators (for specific baseon values, see the API documentation): onReady First response Custom indicators Network time Network request response time Server response time Network request error rate JS error rate, Custom indicators

Request parameter	Type	Required parameter	Description
mpId	Number	Yes	Mini program id
path	String	No	Path
host	String	No	host
uri	String	No	uri
countryId	Number	No	Country Id
regionId	Number	No	Region Id
carrierId	Number	No	Carrier
cityId	Number	No	City
networkType	String	No	Network type
timePeriod	Number	No	Parameter defaults to 30 minutes
endTime	String	No	Deadline Format yyyy-MM-dd HH:mm For example (2018-02-07 17:39)

Return result: Highcharts chart general return result