You need to enable JavaScript to run this app.
导航
JsErrDetailBlankScreenCount
最近更新时间:2023.12.26 18:54:57首次发布时间:2022.11.18 15:32:34

调用JsErrDetailBlankScreenCount接口获取js错误导致的白屏列表。

使用说明

  • 接口名称:JsErrDetailBlankScreenCount
  • 请求方式:POST
  • 接口地址:/?Action=JsErrDetailBlankScreenCount&Version=2022-10-12

请求参数

Query

参数

类型

是否必选

示例值

描述

Action

String

JsErrDetailBlankScreenCount

请求名称。

Version

String

2022-10-12

请求版本。

ServiceName : apmplus_openapi
Region : cn-beijing 
X-App-Ids : xxx
Content-Type : application/json

Body

参数

类型

是否必选

示例值

描述

common

object of common

-

通用参数。

time_filter

object of time_filter

-

时间区间。

pgno

i64

1

页号。

pgsz

i64

10

每页项数。

error_message

string

error message

js错误信息。

order_by

string

score,client_time

排序维度。

order

string

desc,asc

升序或者降序。

common

参数

类型

是否必选

示例值

描述

aid

i64

12345

应用ID。

site_type

string

web

站点类型。

env

string

online

环境,填""时为全部。

os

string

webpro

服务类型,可选值为webproappminipro

user

string

test_user

用户名。

time_filter

参数

类型

是否必选

示例值

描述

start_time

i32

1665485413

起始时间,单位s。

granularity

i32

3600

聚合时间粒度,单位s。

end_time

i32

1665744613

终止时间,单位s。

返回参数

参数

类型

示例值

描述

data

object of data

-

白屏列表。

errmsg

string

-

错误信息,成功为空。

errno

i32

-

错误码,成功为0。

data

参数

类型

示例值

描述

result

array of result

-

白屏列表。

total

i64

10

白屏数。

user_total

i64

10

白屏影响用户数。

result

参数

类型

示例值

描述

url

string

https://www.test.com/path_test?key_1=value_1

发生白屏的页面url。

pid

string

path_test

发生白屏的pid。

client_time

i64

12345678

发生白屏的客户端时间。

score

double

0

白屏得分。

screenshot

string

data:image/jpeg;base64,/9j

白屏页面截图的base64编码值。

session_id

string

12345acd-6400-451a-846c-e1d5622a11fe

发生白屏的session_id。

请求示例

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
}

异常返回示例

{
    "ResponseMetadata": {
        "RequestId": "201806041104200100100232280022D30",
        "Action": "JsErrDetailBlankScreenCount",
        "Version": "2022-10-12",
        "Service": "***",
        "Region": "cn-north-1",
        "Error": {
            "Code": "200000",
            "Message": "参数异常"
        }
    }
}