JSOverviewErrorList

更新时间：2023.04.11 16:29:03

调用JSOverviewErrorList接口获取js错误聚合列表。

使用说明

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

请求参数

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`JSOverviewErrorList`	请求名称。
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	否	`time_ascend`	排序方式。 time_ascend time_descend count_ascend count_descend user_ascend user_descend
pgno	i64	否	`1`	页号。
pgsz	i64	否	`10`	每页项数。

common

参数	类型	是否必选	示例值	描述
aid	i64	是	`12345`	应用ID。
site_type	string	是	`web`	站点类型。
env	string	是	`online`	环境，填""时为全部。
os	string	否	`webpro`	服务类型，可选值为webpro，app，minipro。
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`	筛选条件类型，可选值为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 children	否	-	如果下层还有条件，则放入该处，这一层与field，op，groupkey以及values不能同时存在。

children

参数	类型	是否必选	示例值	描述
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 string	否	-	如果下层还有条件，则放入该处，这一层与field，op，groupkey以及values不能同时存在。

返回参数

参数	类型	示例值	描述
error_msg	string	-	错误信息，成功为空。
error_no	i32	`0`	错误码，成功为0。
data	object of data	-	js错误聚合列表。

data

参数	类型	示例值	描述
result	array of result	-	js错误聚合列表。
total	i64	`10`	js错误聚类总数。

result

参数	类型	示例值	描述
message	string	`Minified React error`	错误信息。
name	string	`Error`	错误类型。
filename	string	`12345.js`	报错文件名。
issue_id	string	`12345`	js错误聚合ID。
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`	当前所选时间区间内js错误最早出现时间。
count	i64	`10`	错误及用户数信息错误数。
count_mini_chart	object of count_mini_chart	-	错误数趋势。
user	i64	`10`	影响用户数。
user_mini_chart	object of user_mini_chart	-	影响用户数趋势。

issue

参数	类型	示例值	描述
id	i64	-	issue在mysql里的id，不同于issue_id。
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)为折线图点的数量或者饼图中块数量。

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=JSOverviewErrorList&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
    },
    "status": [],
    "pgno": 1,
    "filter_conditions": {
        "type": "and",
        "children": [
            {
                "type": "and",
                "values": "[数据探索]",
                "children": [],
                "op": "in",
                "field": "pid",
                "groupKey": "context"
            }
        ],
        "field": "pid",
        "values": "[数据探索]",
        "groupKey": "context",
        "op": "in"
    },
    "order_by": "time_ascend,time_descend,count_ascend,count_descend,user_ascend,user_descend",
    "managers": [],
    "pgsz": 10
}

正常返回示例

{
    "data": {
        "total": 10,
        "result": [
            {
                "issue": {
                    "fixed_version": "v1.1.2",
                    "managers": [
                        {
                            "head_url": "industry",
                            "user_id": 12,
                            "email": "test_user@test.com",
                            "name": "test_user"
                        }
                    ],
                    "status": "processing",
                    "tag": [
                        {
                            "values": [
                                {
                                    "id": 502,
                                    "value": "bladder"
                                }
                            ],
                            "id": 148,
                            "key": ""
                        }
                    ],
                    "id": 418
                },
                "user_mini_chart": {
                    "fields": [
                        {
                            "dataType": "string",
                            "id": "date",
                            "name": "日期",
                            "aggregate": ""
                        }
                    ],
                    "source": [
                        [
                            "1668355200",
                            "js_error",
                            "0",
                            "0"
                        ]
                    ]
                },
                "issue_id": "12345",
                "user": 10,
                "filename": "12345.js",
                "max_crash_time": 1667441262510,
                "done_release": "Out",
                "meego_issue_url": "",
                "git_issue_url": "",
                "name": "Error",
                "count": 10,
                "count_mini_chart": {
                    "source": [
                        [
                            "1668355200",
                            "js_error",
                            "0",
                            "0"
                        ]
                    ],
                    "fields": [
                        {
                            "dataType": "string",
                            "aggregate": "warming",
                            "name": "日期",
                            "id": "date"
                        }
                    ]
                },
                "min_crash_time": 1666781177513,
                "level": "",
                "message": "Minified React error"
            }
        ]
    },
    "error_no": 0,
    "error_msg": ""
}

异常返回示例

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

应用性能监控全链路版

JSOverviewErrorList

使用说明

请求参数

Query

Header

Body

common

time_filter

filter_conditions

children

返回参数

data

result

issue

count_mini_chart

user_mini_chart

managers

fields

示例

请求示例

正常返回示例

异常返回示例

应用性能监控全链路版

JSOverviewErrorList

使用说明 #

请求参数 #

Query #

Header #

Body #

common #

time_filter #

filter_conditions #

children #

返回参数 #

data #

result #

issue #

count_mini_chart #

user_mini_chart #

managers #

fields #

示例 #

请求示例 #

正常返回示例 #

异常返回示例 #

使用说明

请求参数

Query

Header

Body

common

time_filter

filter_conditions

children

返回参数

data

result

issue

count_mini_chart

user_mini_chart

managers

fields

示例

请求示例

正常返回示例

异常返回示例