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

调用BlankScreenOverviewList接口获取不同归因类型的白屏列表。

使用说明

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

请求参数

Query

参数

类型

是否必选

示例值

描述

Action

String

BlankScreenOverviewList

请求名称。

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

-

时间区间。

filter_conditions

object of filter_conditions

-

筛选条件。

order_by

string

score

排序维度。

  • score
  • client_time
  • time
  • count
  • user

order

string

desc

排序方式。

  • desc
  • asc

pgno

i64

1

页号

pgsz

i64

10

每页项数。

type

string

js_error

归因类型。

  • js_error
  • resource_error
  • http_error
  • unclassified

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。

filter_conditions

参数

类型

是否必选

示例值

描述

type

string

and

筛选条件类型,可选值为andrule,只支持两层,第一层的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 children

-

如果下层还有条件,则放入该处,这一层与field,op,groupkey以及values不能同时存在。

children

参数

类型

是否必选

示例值

描述

type

string

and

筛选条件类型,可选值为andrule,只支持两层,第一层的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 string

-

如果下层还有条件,则放入该处,这一层与field,op,groupkey以及values不能同时存在。

返回参数

参数

类型

示例值

描述

errno

i32

0

错误码,成功为0。

errmsg

string

-

错误信息,成功为空。

data

object of data

-

白屏归因聚合列表

data

参数

类型

示例值

描述

js_error

object of js_error

-

js错误导致白屏情况列表。

unclassified

object of unclassified

-

无法归因的白屏列表。

http_error

object of http_error

-

请求错误导致的白屏列表。

resource_error

object of resource_error

-

静态资源错误导致的白屏列表

js_error

参数

类型

示例值

描述

result

array of result

-

js错误聚合列表。

total

i64

10

js错误聚类总数。

unclassified

参数

类型

示例值

描述

result

array of result

-

无法归因的白屏列表。

total

i64

10

无法归因的白屏数。

http_error

参数

类型

示例值

描述

result

array of result

-

导致白屏的请求错误聚合列表。

total

i64

10

导致白屏的请求错误聚类总数。

resource_error

参数

类型

示例值

描述

result

array of result

-

导致白屏的静态资源错误聚合列表。

total

i64

10

导致白屏的静态资源错误聚类总数。

result

参数

类型

示例值

描述

message

string

Minified React error

错误信息。

name

string

Error

错误类型。

filename

string

12345.js

报错文件名。

issue_id

string

12345

issue 状态操作。

issue

object of issue

-

issue分配信息。

meego_issue_url

string

-

如果 issue_status 不为 done,则不设置这个字段。

level

string

-

起止时间。

max_crash_time

i64

1667441262510

当前所选时间区间内js错误最晚出现时间。

min_crash_time

i64

1666781177513

错误及用户数信息。

count

i64

10

错误数

count_mini_chart

object of count_mini_chart

-

错误数趋势。

user

i64

10

影响用户数。

user_mini_chart

object of user_mini_chart

-

影响用户数趋势。

result

参数

类型

示例值

描述

url

string

https://www.test.com/path_test?key1=value1

白屏页面url。

pid

string

path_test

白屏页面pid。

client_time

i64

1667313554658

白屏发生的客户端时间。

score

double

0

白屏分数。

screenshot

string

data:image/jpeg;base64,/9j/4AAQS

白屏现场截图base64编码值。

session_id

string

049437a9

白屏关联的session_id

result

参数

类型

示例值

描述

domain

string

www.test.com

请求错误域名。

path

string

path_test

请求错误path

count

i64

10

请求错误数。

user

i64

10

请求错误影响用户数。

distribution

object of distribution

-

请求错误状态码分布情况。

count_trend

object of count_trend

-

请求错误数趋势。

user_trend

object of user_trend

-

请求错误影响用户数趋势。

result

参数

类型

示例值

描述

domain

string

www.test.com

静态资源错误域名。

path

string

path_test

静态资源错误path。

type

string

resource

静态资源错误类型。

count

i64

10

静态资源错误数。

user

i64

10

静态资源错误影响用户数。

count_trend

object of count_trend

-

静态资源错误数趋势。

user_trend

object of user_trend

-

静态资源错误影响用户数趋势。

url

string

-

静态资源错误url。

issue

参数

类型

示例值

描述

managers

array of managers

-

issue处理人。

status

string

processing

issue状态。

fixed_version

string

v1.1.2

修复版本号。

count_mini_chart

参数

类型

示例值

描述

fields

array of fields

-

折线图/饼图维度,len(fields)=len(source[i])。

source

array of string

[["1668355200","js_error","0","0"]]

趋势图具体点的集合,len(source)为折线图点的数量或者饼图中块数量。

user_mini_chart

参数

类型

示例值

描述

fields

array of fields

-

折线图/饼图维度,len(fields)=len(source[i])。

source

array of string

[["1668355200","js_error","0","0"]]

趋势图具体点的集合,len(source)为折线图点的数量或者饼图中块数量。

distribution

参数

类型

示例值

描述

fields

array of fields

-

折线图/饼图维度,len(fields)=len(source[i])。

source

array of string

[["1668355200","js_error","0","0"]]

趋势图具体点的集合,len(source)为折线图点的数量或者饼图中块数量。

count_trend

参数

类型

示例值

描述

fields

array of fields

-

折线图/饼图维度,len(fields)=len(source[i])。

source

array of string

[["1668355200","js_error","0","0"]]

趋势图具体点的集合,len(source)为折线图点的数量或者饼图中块数量。

user_trend

参数

类型

示例值

描述

fields

array of fields

-

折线图/饼图维度,len(fields)=len(source[i])。

source

array of string

[["1668355200","js_error","0","0"]]

趋势图具体点的集合,len(source)为折线图点的数量或者饼图中块数量。

managers

参数

类型

示例值

描述

name

string

test_user

处理人名。

user_id

i64

12

处理人ID。

email

string

test_user@test.com

处理人邮箱。

fields

参数

类型

示例值

描述

id

string

date

维度key。

dataType

string

string

维度类型。

name

string

日期

维度名。

aggregate

string

-

聚合方式。

请求示例

POST https://open.volcengineapi.com/?Action=BlankScreenOverviewList&Version=2022-10-12 
{
    "common": {
        "aid": 12345,
        "site_type": "web",
        "env": "online",
        "user": "test_user",
        "os": "webpro"
    },
    "time_filter": {
        "start_time": 1665485413,
        "end_time": 1665744613,
        "granularity": 3600
    },
    "pgno": 1,
    "pgsz": 10,
    "type": "js_error, resource_error, http_error, unclassified",
    "order_by": "score,client_time,time,count,user",
    "filter_conditions": {
        "type": "and",
        "children": [
            {
                "type": "and",
                "children": [],
                "groupKey": "context",
                "field": "pid",
                "values": "[数据探索]",
                "op": "in"
            }
        ],
        "values": "[数据探索]",
        "groupKey": "context",
        "field": "pid",
        "op": "in"
    },
    "order": "desc,asc"
}

返回示例

正常返回示例

{
    "errmsg": "",
    "data": {
        "http_error": {
            "result": [
                {
                    "user": 10,
                    "domain": "www.test.com",
                    "path": "path_test",
                    "distribution": {
                        "source": [
                            [
                                "1668355200",
                                "js_error",
                                "0",
                                "0"
                            ]
                        ],
                        "fields": [
                            {
                                "dataType": "string",
                                "id": "date",
                                "name": "日期",
                                "aggregate": "Sheet"
                            }
                        ]
                    },
                    "count_trend": {
                        "source": [
                            [
                                "1668355200",
                                "js_error",
                                "0",
                                "0"
                            ]
                        ],
                        "fields": [
                            {
                                "id": "date",
                                "name": "日期",
                                "aggregate": "clubbing",
                                "dataType": "string"
                            }
                        ]
                    },
                    "count": 10,
                    "user_trend": {
                        "source": [
                            [
                                "1668355200",
                                "js_error",
                                "0",
                                "0"
                            ]
                        ],
                        "fields": [
                            {
                                "id": "date",
                                "name": "日期",
                                "dataType": "string",
                                "aggregate": ""
                            }
                        ]
                    }
                }
            ],
            "total": 10
        },
        "unclassified": {
            "result": [
                {
                    "url": "https://www.test.com/path_test?key1=value1",
                    "client_time": 1667313554658,
                    "session_id": "049437a9",
                    "score": 51,
                    "screenshot": "data:image/jpeg;base64,/9j/4AAQS",
                    "pid": "path_test"
                }
            ],
            "total": 10
        },
        "resource_error": {
            "result": [
                {
                    "path": "path_test",
                    "domain": "www.test.com",
                    "url": "reflection",
                    "count": 10,
                    "user_trend": {
                        "source": [
                            [
                                "1668355200",
                                "js_error",
                                "0",
                                "0"
                            ]
                        ],
                        "fields": [
                            {
                                "id": "date",
                                "name": "日期",
                                "dataType": "string",
                                "aggregate": ""
                            }
                        ]
                    },
                    "user": 10,
                    "type": "resource",
                    "count_trend": {
                        "fields": [
                            {
                                "name": "日期",
                                "id": "date",
                                "aggregate": "virtue",
                                "dataType": "string"
                            }
                        ],
                        "source": [
                            [
                                "1668355200",
                                "js_error",
                                "0",
                                "0"
                            ]
                        ]
                    }
                }
            ],
            "total": 10
        },
        "js_error": {
            "result": [
                {
                    "user": 10,
                    "min_crash_time": 1666781177513,
                    "user_mini_chart": {
                        "fields": [
                            {
                                "dataType": "string",
                                "id": "date",
                                "name": "日期",
                                "aggregate": "wildly"
                            }
                        ],
                        "source": [
                            [
                                "1668355200",
                                "js_error",
                                "0",
                                "0"
                            ]
                        ]
                    },
                    "name": "Error",
                    "done_release": "percent",
                    "filename": "12345.js",
                    "count": 10,
                    "level": "disappear",
                    "max_crash_time": 1667441262510,
                    "issue_id": "12345",
                    "git_issue_url": "",
                    "count_mini_chart": {
                        "source": [
                            [
                                "1668355200",
                                "js_error",
                                "0",
                                "0"
                            ]
                        ],
                        "fields": [
                            {
                                "aggregate": "",
                                "dataType": "string",
                                "name": "日期",
                                "id": "date"
                            }
                        ]
                    },
                    "issue": {
                        "managers": [
                            {
                                "email": "test_user@test.com",
                                "name": "test_user",
                                "head_url": "",
                                "user_id": 12
                            }
                        ],
                        "id": 886,
                        "fixed_version": "v1.1.2",
                        "tag": [
                            {
                                "key": "",
                                "values": [
                                    {
                                        "value": "",
                                        "id": 419
                                    }
                                ],
                                "id": 401
                            }
                        ],
                        "status": "processing"
                    },
                    "message": "Minified React error",
                    "meego_issue_url": "beyond"
                }
            ],
            "total": 10
        }
    },
    "errno": 0
}

异常返回示例

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