WeChat interface analysis

Interface overview

POST /adhoc/query

Body request parameter

{
    "timePeriod": 360,
    "endTime": "",
    "filters": [
        {
            "name": "mpId",
            "value": [
                10
            ],
            "operator": "IN"
        }
    ],
    "datasource": "BRS_WECHAT_APPLET",
    "dimensions": [
        "timeStr"
    ],
    "metrics": [
        "apiCount",
        "apiFailCount",
        "apiCancelCount",
        "apiSuccessCount",
        "apiSuccessUV",
        "apiFailUV",
        "apiCancelUV",
        "apiSuccessRate"
    ],
    "render": "chart"
}

Request Parameters

Name	Location	Type	Required	Description
body	body	object	No	none

Return Results

Status Code	Meaning of status code	Description	Data Model
200	OK	none	Inline

Return data structure

Status Code 200

Interface list

POST /adhoc/query

Body request parameter

{
    "datasource": "BRS_WECHAT_APPLET",
    "timePeriod": 360,
    "endTime": "",
    "metrics": [
        "apiCount",
        "apiSuccessCount",
        "apiFailCount",
        "apiCancelCount",
        "apiSuccessRate",
        "apiSuccessUV",
        "apiFailUV",
        "apiCancelUV"
    ],
    "dimensions": [
        "apiName"
    ],
    "filters": [
        {
            "name": "mpId",
            "value": [
                10
            ],
            "operator": "IN"
        },
        {
            "name": "messageType",
            "value": [
                "API"
            ],
            "operator": "IN"
        }
    ],
    "orderByExprs": "apiCount desc",
    "limit": 1000,
    "render": "object"
}

Request Parameters

Name	Location	Type	Required	Description
body	body	object	No	none

Return Example

[
    {
      "apiSuccessRate": {
        "format": "0",
        "label": "Success Percent",
        "unit": "%",
        "value": 0
      },
      "apiFailUV": {
        "format": "1",
        "label": "Fail User Count",
        "unit": "",
        "value": 1
      },
      "apiName": "requestPayment",
      "apiCancelCount": {
        "format": "0",
        "label": "Cancel Count",
        "unit": "",
        "value": 0
      },
      "apiFailCount": {
        "format": "2",
        "label": "Fail Count",
        "unit": "",
        "value": 2
      },
      "apiCount": {
        "format": "2",
        "label": "Call Count",
        "unit": "",
        "value": 2
      },
      "apiCancelUV": {
        "format": "0",
        "label": "Fail User Count",
        "unit": "",
        "value": 0
      },
      "apiAlias": "requestPayment",
      "apiSuccessCount": {
        "format": "0",
        "label": "Success Count",
        "unit": "",
        "value": 0
      },
      "apiSuccessUV": {
        "format": "0",
        "label": "Fail User Count",
        "unit": "",
        "value": 0
      }
    }
]

Return Results

Status Code	Meaning of status code	Description	Data Model
200	OK	none	Inline

Return data structure

Status Code 200

Name	Type	Required	Constraints	Chinese name	Description
» apiSuccessRate	object	true	none		none
»» format	string	true	none		none
»» label	string	true	none		none
»» unit	string	true	none		none
»» value	integer	true	none		none
» apiFailUV	object	true	none		none
»» format	string	true	none		none
»» label	string	true	none		none
»» unit	string	true	none		none
»» value	integer	true	none		none
» apiName	string	true	none		none
» apiCancelCount	object	true	none		none
»» format	string	true	none		none
»» label	string	true	none		none
»» unit	string	true	none		none
»» value	integer	true	none		none
» apiFailCount	object	true	none		none
»» format	string	true	none		none
»» label	string	true	none		none
»» unit	string	true	none		none
»» value	integer	true	none		none
» apiCount	object	true	none		none
»» format	string	true	none		none
»» label	string	true	none		none
»» unit	string	true	none		none
»» value	integer	true	none		none
» apiCancelUV	object	true	none		none
»» format	string	true	none		none
»» label	string	true	none		none
»» unit	string	true	none		none
»» value	integer	true	none		none
» apiAlias	string	true	none		none
» apiSuccessCount	object	true	none		none
»» format	string	true	none		none
»» label	string	true	none		none
»» unit	string	true	none		none
»» value	integer	true	none		none
» apiSuccessUV	object	true	none		none
»» format	string	true	none		none
»» label	string	true	none		none
»» unit	string	true	none		none
»» value	integer	true	none		none

Wechat API/API-Trace

API fail-Trace

POST /adhoc/query

Body request parameter

{
    "datasource": "MP_API_TRACE",
    "timePeriod": 10080,
    "endTime": "",
    "metrics": [],
    "dimensions": [
        "timestamp",
        "apiName",
        "apiStatus",
        "userId",
        "sessionId",
        "ip",
        "countryId",
        "regionId",
        "cityId",
        "countyId",
        "carrierId",
        "connectType",
        "wechatVersion",
        "system",
        "deviceType"
    ],
    "filters": [
        {
            "name": "mpId",
            "value": [
                10
            ],
            "operator": "IN"
        },
        {
            "name": "apiStatus",
            "value": [
                2
            ],
            "operator": "IN"
        }
    ],
    "groupBy": false,
    "orderByExprs": "timestamp desc",
    "limit": 10,
    "render": "object"
}

Request Parameters

Name	Location	Type	Required	Description
body	body	object	No	none

Return Example

[
  {
    "deviceType": "iPhone 12/13 (Pro)",
    "apiName": "requestPayment",
    "connectType": "wifi",
    "ip": "114.242.217.98",
    "regionName": "Beijing",
    "apiAlias": "requestPayment",
    "sessionId": "bd99dc19-ad68-4215-9a8e-e19c13486083",
    "cityId": 481101,
    "userId": "testUser",
    "countryId": 48,
    "system": "iOS 10.0.1",
    "cityName": "Beijing",
    "carrierName": "China Unicom",
    "regionId": 4811,
    "apiStatusName": "Fail",
    "countyId": 48110105,
    "wechatVersion": "8.0.5",
    "countryName": "China",
    "carrierId": 16,
    "apiStatus": 2,
    "timestamp": 1742370085000,
    "countyName": "朝阳区"
  }
]

Return Results

Status Code	Meaning of status code	Description	Data Model
200	OK	none	Inline

Return data structure

Status Code 200

Name	Type	Required	Constraints	Chinese name	Description
» deviceType	string	true	none		none
» apiName	string	true	none		none
» connectType	string	true	none		none
» ip	string	true	none		none
» regionName	string	true	none		none
» apiAlias	string	true	none		none
» sessionId	string	true	none		none
» cityId	integer	true	none		none
» userId	string	true	none		none
» countryId	integer	true	none		none
» system	string	true	none		none
» cityName	string	true	none		none
» carrierName	string	true	none		none
» regionId	integer	true	none		none
» apiStatusName	string	true	none		none
» countyId	integer	true	none		none
» wechatVersion	string	true	none		none
» countryName	string	true	none		none
» carrierId	integer	true	none		none
» apiStatus	integer	true	none		none
» timestamp	integer	true	none		none
» countyName	string	true	none		none

API cancle-Trace

POST /adhoc/query

Body request parameter

{
    "datasource": "MP_API_TRACE",
    "timePeriod": 10080,
    "endTime": "",
    "metrics": [],
    "dimensions": [
        "timestamp",
        "apiName",
        "apiStatus",
        "userId",
        "sessionId",
        "ip",
        "countryId",
        "regionId",
        "cityId",
        "countyId",
        "carrierId",
        "connectType",
        "wechatVersion",
        "system",
        "deviceType"
    ],
    "filters": [
        {
            "name": "mpId",
            "value": [
                10
            ],
            "operator": "IN"
        },
        {
            "name": "apiStatus",
            "value": [
                3
            ],
            "operator": "IN"
        }
    ],
    "groupBy": false,
    "orderByExprs": "timestamp desc",
    "limit": 10,
    "render": "object"
}

Request Parameters

Name	Location	Type	Required	Description
body	body	object	No	none

Return Example

200 Response

{}

Return Results

Status Code	Meaning of status code	Description	Data Model
200	OK	none	Inline

Return data structure

API success-Trace

POST /adhoc/query

Body request parameter

{
    "datasource": "MP_API_TRACE",
    "timePeriod": 10080,
    "endTime": "",
    "metrics": [],
    "dimensions": [
        "timestamp",
        "apiName",
        "apiStatus",
        "userId",
        "sessionId",
        "ip",
        "countryId",
        "regionId",
        "cityId",
        "countyId",
        "carrierId",
        "connectType",
        "wechatVersion",
        "system",
        "deviceType"
    ],
    "filters": [
        {
            "name": "mpId",
            "value": [
                10
            ],
            "operator": "IN"
        },
        {
            "name": "apiStatus",
            "value": [
                1
            ],
            "operator": "IN"
        }
    ],
    "groupBy": false,
    "orderByExprs": "timestamp desc",
    "limit": 10,
    "render": "object"
}

Request Parameters

Name	Location	Type	Required	Description
body	body	object	No	none

Return Example

[
  {
    "deviceType": "iPhone 12/13 (Pro)",
    "apiName": "previewImage",
    "connectType": "wifi",
    "ip": "114.242.217.98",
    "regionName": "Beijing",
    "apiAlias": "previewImage",
    "sessionId": "c6868eb0-f6d4-4b37-93b9-5a19fe852c03",
    "cityId": 481101,
    "userId": "testUser",
    "countryId": 48,
    "system": "iOS 10.0.1",
    "cityName": "Beijing",
    "carrierName": "China Unicom",
    "regionId": 4811,
    "apiStatusName": "Success",
    "countyId": 48110105,
    "wechatVersion": "8.0.5",
    "countryName": "China",
    "carrierId": 16,
    "apiStatus": 1,
    "timestamp": 1742370282000,
    "countyName": "朝阳区"
  }
]

Return Results

Status Code	Meaning of status code	Description	Data Model
200	OK	none	Inline

Return data structure

Status Code 200

Name	Type	Required	Constraints	Chinese name	Description
» deviceType	string	false	none		none
» apiName	string	false	none		none
» connectType	string	false	none		none
» ip	string	false	none		none
» regionName	string	false	none		none
» apiAlias	string	false	none		none
» sessionId	string	false	none		none
» cityId	integer	false	none		none
» userId	string	false	none		none
» countryId	integer	false	none		none
» system	string	false	none		none
» cityName	string	false	none		none
» carrierName	string	false	none		none
» regionId	integer	false	none		none
» apiStatusName	string	false	none		none
» countyId	integer	false	none		none
» wechatVersion	string	false	none		none
» countryName	string	false	none		none
» carrierId	integer	false	none		none
» apiStatus	integer	false	none		none
» timestamp	integer	false	none		none
» countyName	string	false	none		none