You need to enable JavaScript to run this app.
导航
应用性能监控全链路版
  • 文档首页
    • /应用性能监控全链路版/OpenAPI参考/WebPro端/JS错误监控/JSOverviewErrorList
JSOverviewErrorList
最近更新时间：2024.07.12 17:21:38首次发布时间：2022.11.18 15:32:34
我的收藏

获取JS错误聚合列表。

请求说明

  • 请求方式：POST
  • 请求地址：https://open.volcengineapi.com/?Action=JSOverviewErrorList&Version=2022-10-12
ServiceName: apmplus_openapi
Region: cn-beijing 
X-App-Ids: xxx
Content-Type: application/json

请求参数

Query

参数类型是否必选示例值描述
ActionString是JSOverviewErrorList接口名称。当前 API 的名称为 JSOverviewErrorList。
VersionString是2022-10-12接口版本。当前 API 的版本为 2022-10-12。

Body

参数类型是否必选示例值描述
commonObject of CommonParams是-通用参数。
time_filterObject of TimeFilter是-时间区间。
filter_conditionsObject of FilterCondition否-筛选条件。

order_by

String

否

time_ascend

排序方式。

  • time_ascend
  • time_descend
  • count_ascend
  • count_descend
  • user_ascend
  • user_descend
pgnoLong否1页号。
pgszLong否10每页项数。

CommonParams

参数类型是否必选示例值描述
aidLong是12345应用ID。
site_typeString是web站点类型。
envString是online环境，填""时为全部。
osString否webpro服务类型，可选值为webpro，app，minipro。
userString否test_user用户名。

TimeFilter

参数类型是否必选示例值描述
start_timeInteger是1665485413起始时间，单位s。
end_timeInteger是1665744613终止时间，单位s。
granularityInteger否3600聚合时间粒度，单位s。

FilterCondition

参数类型是否必选示例值描述
typeString是and筛选条件类型，可选值为and和rule，只支持两层，第一层的type必须为and，第二层的type必须为rule。
fieldString否pid条件字段key，可选值集合由GetFieldKeys方法获取。
opString否in条件符号，可选值有eq，neq，lt，lte，gt，gte，in，not_in，regex，not_regex。
groupKeyString否contextmap类型字段key，可选值集合由GetFieldKeys方法获取。
valuesArray of String否[数据探索]条件值，可选值集合由GetFieldValues方法获取。
childrenArray of FilterCondition否-如果下层还有条件，则放入该处，即type为and时必填。这一层与field，op，groupkey以及values不能同时存在。

返回参数

参数类型示例值描述
error_msgString-错误信息，成功为空。
error_noInteger0错误码，成功为0。
dataObject of OverviewErrorListResponseData-JS错误聚合列表。

OverviewErrorListResponseData

参数类型示例值描述
totalLong10JS错误聚类总数。
resultArray of ErrorListItem-JS错误聚合列表。

ErrorListItem

参数类型示例值描述
messageStringMinified React error错误信息。
nameStringError错误类型。
filenameString12345.js报错文件名。
issue_idString12345issue状态操作。
issueObject of IssueInfo-issue分配信息。
meego_issue_urlString-如果issue_status不为done，则不设置这个字段。
levelString-起止时间。
max_crash_timeLong1667441262510当前所选时间区间内JS错误最晚出现时间。
min_crash_timeLong1666781177513错误及用户数信息。
countLong10错误及用户数信息错误数。
count_mini_chartObject of ChartData-错误数趋势。
userLong10影响用户数。
user_mini_chartObject of ChartData-影响用户数趋势。

IssueInfo

参数类型示例值描述
managersArray of IssueManager-issue处理人。
statusStringprocessingissue状态。
fixed_versionStringv1.1.2修复版本号。

ChartData

参数类型示例值描述
fieldsArray of Field-折线图/饼图维度，len(fields)=len(source[i])。
sourceArray of String[["1668355200","js_error","0","0"]]趋势图具体点的集合，len(source)为折线图点的数量或者饼图中块数量。

IssueManager

参数类型示例值描述
nameStringtest_user处理人名。
emailStringtest_user@test.com处理人邮箱。
user_idLong12处理人ID。

Field

参数类型示例值描述
idStringdate维度key。
nameString日期维度名。
dataTypeStringstring维度类型。
aggregateString-聚合方式。

请求示例

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": ""
}

错误码

本接口无特有的错误码。更多信息请参见错误码。