获取JS错误导致的白屏列表。
请求说明
- 请求方式：POST
- 请求地址：https://open.volcengineapi.com/?Action=JsErrDetailBlankScreenCount&Version=2022-10-12
ServiceName: apmplus_openapi
Region: cn-beijing
X-App-Ids: xxx
Content-Type: application/json
请求参数
Query
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|
| Action | String | 是 | JsErrDetailBlankScreenCount | 接口名称。当前 API 的名称为 JsErrDetailBlankScreenCount。 |
| Version | String | 是 | 2022-10-12 | 接口版本。当前 API 的版本为 2022-10-12。 |
Body
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|
| common | Object of CommonParams | 是 | - | 通用参数。 |
| time_filter | Object of TimeFilter | 是 | - | 时间区间。 |
| pgno | Long | 是 | 1 | 页号。 |
| pgsz | Long | 是 | 10 | 每页项数。 |
| error_message | String | 否 | error message | JS错误信息。 |
| order_by | String | 否 | score,client_time | 排序维度。 |
| order | String | 否 | desc,asc | 升序或者降序。 |
| filter_conditions | Object of FilterCondition | 否 | - | 筛选条件。 |
CommonParams
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|
| aid | Long | 是 | 12345 | 应用ID。 |
| site_type | String | 是 | web | 站点类型。 |
| env | String | 是 | online | 环境，填""时为全部。 |
| os | String | 否 | webpro | 服务类型，可选值为webpro，app，minipro。 |
| user | String | 否 | test_user | 用户名。 |
TimeFilter
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|
| start_time | Integer | 是 | 1665485413 | 起始时间，单位s。 |
| end_time | Integer | 是 | 1665744613 | 终止时间，单位s。 |
| granularity | Integer | 否 | 3600 | 聚合时间粒度，单位s。 |
FilterCondition
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|
| type | String | 是 | and | 筛选条件类型，可选值为and和rule，只支持两层，第一层的type必须为and，第二层的type必须为rule。 |
| field | String | 否 | pid | 条件字段key，可选值集合由GetFieldKeys方法获取。 |
| op | String | 否 | in | 条件符号，可选值有eq，neq，lt，lte，gt，gte，in，not_in，regex，not_regex。 |
| groupKey | String | 否 | context | map类型字段key，可选值集合由GetFieldKeys方法获取。 |
| values | Array of String | 否 | [数据探索] | 条件值，可选值集合由GetFieldValues方法获取。 |
| children | Array of FilterCondition | 否 | - | 如果下层还有条件，则放入该处，即type为and时必填。这一层与field，op，groupkey以及values不能同时存在。 |
返回参数
OverallListResponseData
| 参数 | 类型 | 示例值 | 描述 |
|---|
| total | Long | 10 | 白屏数。 |
| result | Array of ListItem | - | 白屏列表。 |
| user_total | Long | 10 | 白屏影响用户数。 |
ListItem
| 参数 | 类型 | 示例值 | 描述 |
|---|
| pid | String | path_test | 发生白屏的pid。 |
| url | String | https://www.test.com/path_test?key_1=value_1 | 发生白屏的页面url。 |
| score | Double | 0 | 白屏得分。 |
| screenshot | String | data:image/jpeg;base64,/9j | 白屏页面截图的base64编码值。 |
| session_id | String | 12345acd-6400-451a-846c-e1d5622a11fe | 发生白屏的session_id。 |
| client_time | Long | 12345678 | 发生白屏的客户端时间。 |
请求示例
POST https://open.volcengineapi.com/?Action=JsErrDetailBlankScreenCount&Version=2022-10-12
{
"common": {
"aid": 12345,
"site_type": "web",
"env": "online",
"os": "webpro",
"user": "test_user"
},
"time_filter": {
"start_time": 1665485413,
"end_time": 1665744613,
"granularity": 3600
},
"issue_id": "Terrace",
"pgno": 1,
"pgsz": 10,
"error_message": "error message",
"order_by": "score,client_time",
"order": "desc,asc"
}
返回示例
{
"data": {
"result": [
{
"session_id": "12345acd-6400-451a-846c-e1d5622a11fe",
"screenshot": "data:image/jpeg;base64,/9j",
"pid": "path_test",
"client_time": 12345678,
"score": 363,
"url": "https://www.test.com/path_test?key_1=value_1"
}
],
"total": 10,
"user_total": 10
},
"errmsg": "",
"errno": 0
}
错误码
本接口无特有的错误码。更多信息请参见错误码。