WeChat interface analysis

Interface overview

Interface list

POST /wxapi/list

Request parameters:

Request parameters	Type	Required parameters	Description
mpId	Number	is	Mini Program ID
timePeriod	Number	No	The parameter defaults to 30 minutes
endTime	String	No	End time. Format yyyy-MM-dd HH:mm, for example (2018-02-07 17:39)

Return results:

[
    {
        "apiName": "scanCode",
        "displayApiName": "scanCode",
        "apiFailCount": 3,
        "apiCallCount": 3,
        "apiSuccessRate": 0.0, // success rate
        "apiFailUserCount": 1, // Number of failed users
        "apiInfluenceUserCount": 1 // Number of users affected
    },
    ...
]

Interface details

Interface details overview information

POST /wxapi/detail

Request parameters:

Request parameters	Type	Required parameters	Description
mpId	Number	is	Mini Program ID
apiName	String	is	interface name
timePeriod	Number	No	The parameter defaults to 30 minutes
endTime	String	No	End time. Format yyyy-MM-dd HH:mm, for example (2018-02-07 17:39)

Return results:

{
    "apiName": "scanCode",
    "displayApiName": "scanCode",
    "apiFailCount": 3,
    "apiCallCount": 3,
    "apiCancelCount": 0,
    "apiSuccessRate": 0.0,
    "apiFailUserCount": 1,
    "apiInfluenceUserCount": 1
}

Interface call trend chart

POST /chart/api-trend

Request parameters:

Request parameters	Type	Required parameters	Description
mpId	Number	is	Mini Program ID
apiName	String	is	interface name
timePeriod	Number	No	The parameter defaults to 30 minutes
endTime	String	No	End time. Format yyyy-MM-dd HH:mm, for example (2018-02-07 17:39)

Return data: (Highcharts chart general return results)

Interface trace list

POST /wxapi/trace-list

Request parameters:

Request parameters	Type	Required parameters	Description
mpId	Number	is	Mini Program ID
apiName	String	is	interface name
timePeriod	Number	No	The parameter defaults to 30 minutes
endTime	String	No	End time. Format yyyy-MM-dd HH:mm, for example (2018-02-07 17:39)
statusFilter	Number	No	Specify filter conditions. 1: Success 2: Failure 3: Cancel

Return data:

{
    "timestamp": "2019-11-15 11:18",
    "id": "IpERbW4Bw-wCxOz_rEu9",
    "apiName": "scanCode",
    "apiSuccessCount": 0,
    "apiFailCount": 1,
    "apiCancelCount": 0,
    "apiCallCount": 0,
    "sid": "7cfcb6c9-3edf-4d9d-a6f2-8ed172217e45",
    "uid": "5847de28-2b35-4d6e-b977-ff54a685c7d4",
    "ip": "192.168.5.149",
    "apiStatus": 2, // 1: Success 2: Failure 3: Cancel
    "failMessage": "{\"errMsg\":\"scanCode:fail\"}"
}